Users

<b>BETA:</b> Returns the list of client view users

get/sites/{site-identifier}/client-view-users

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/client-view-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

Query parameters

type'FUND' | 'ADVISER' | 'AUDITOR'

The client view user query type.

status'Active' | 'Inactive' | 'Invited' | 'Invitation Expired' | 'Not Invited'

The client view user status

fund-identifierstring

The GUID that identifies a fund

list-identifierstring
Example:f40ed4cc-00dd-c798-d314-7893a8a948e6

This will allow the caller to filter on a specific

  • The code of the fund list, e.g /client-view/users?type=FUND&list-identifier=ALL => Return all client view member/trustee users of all active funds.
  • The ADVISER, e.g /client-view/users?type=ADVISER&list-identifier=ADVISER => Return all client view adviser users.
  • The ADVISER-ASSISTANT, e.g /client-view/users?type=ADVISER&list-identifier=ADVISER-ASSISTANT => Return all client view adviser assistant users.

The json object representing the fund list definition.

adviser-guidstring
Example:e3c76443-8126-05b6-9914-c88c1ce84725

The GUID that identifies a specified adviser

include-child-adviserboolean
Example:true

Include all advisers of a specific Firm/Dealer Group

include-linked-adviser-assistantboolean
Example:true

Include all adviser assistants of a specific adviser

adviser-assistant-guidstring
Example:bd6237b2-e306-1088-e014-eb355800cffe

The GUID that identifies an adviser assistant

Response

Success

UserGUIDstring guid
IdentityGUIDstring guid
EmailAddressstring
MaskedMobileNumberstring
Namestring
UserCodestring
Status'Active' | 'Inactive' | 'Invited' | 'Invitation Expired' | 'Not Invited'
InviteRequestDatestring date-time
Role'ADVISER' | 'ADVISER-ASSISTANT' | 'AUDITOR' | 'USER' | 'TRUSTEE'
AdviserGUIDstring guid
AuditorGUIDstring guid
PersonGUIDstring guid
EntityCodestring
EntityDescriptionstring
LastAccessDateTimestring date-time
MultifactorMethod'SMS' | 'APP'
MultifactorStatusstring

Example response

[
  {
    "UserGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f1",
    "IdentityGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f2",
    "EmailAddress": "tiara.erskin@hotmail.com",
    "MaskedMobileNumber": "04xxxxx456",
    "Name": "Tiara Erskin",
    "UserCode": "tiara.erskin@hotmail.com",
    "InviteRequestDate": "2023-02-02T10:12:58.450+07:00",
    "AdviserGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f3",
    "EntityDescription": "Charter Financial Planning (Brisbane Office)",
    "Funds": [
      {
        "Fund": "SMARTSMSF",
        "Name": "Smart superannuation fund"
      }
    ],
    "Actions": [
      "edit",
      "invite",
      "reinvite",
      "disable",
      "reactivate",
      "reset-password",
      "reset-mfa"
    ],
    "LastAccessDateTime": "2023-02-03T09:39:25.317+07:00",
    "MultifactorStatus": "ENABLED"
  }
]

Changes

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