Users

Get the client portal users for the fund.

get/sites/{site-identifier}/funds/{fund-identifier}/users

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/funds/{fund-identifier}/users
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

fund-identifierstring required

The GUID that identifies a fund

Response

Success

PersonGUIDstring
IdentityGUIDstring
UserGUIDstring
EmailAddressstring
Namestring
Statusstring
InviteRequestDatestring date-time
InviteRequestStatusstring
MFAStatusstring
LastLoggedInstring date
RetiredDatestring date
Deceasedboolean
Actionsstring
Rolestring
AdviserGUIDstring guid
MultifactorMethodstring
MultifactorStatusstring
EmailAddressVerifiedDateTimestring date-time
MaskedMobileNumberstring

Example response

[
  {
    "PersonGUID": "b0c21331-6e4d-d18f-8a14-3a410c693639",
    "IdentityGUID": "b0c21331-4r3c-12de-dfry-r5nas4gj5f79",
    "UserGUID": "lkd97832-j8rh-f73h-or83-poe92jf7363f",
    "EmailAddress": "john.smith@gmail.com",
    "Name": "John Smith",
    "Status": "Inactive",
    "InviteRequestDate": "2020-03-24T15:55:52.679+07:00",
    "InviteRequestStatus": "EXPIRED",
    "MFAStatus": "AVAILABLE",
    "LastLoggedIn": "2020-04-24T20:55:52.679+07:00",
    "RetiredDate": "2029-01-24T20:55:52.679+07:00",
    "Role": "ADVISER",
    "AdviserGUID": "b0c21331-6e4d-d18f-8a14-3a410c693640",
    "MultifactorMethod": "APP",
    "MultifactorStatus": "ENABLED",
    "MaskedMobileNumber": "04******78"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.