Users

Get the users for the site

get/sites/{site-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}/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

statusstring
Example:Active/Inactive/Invited

Status of user

identity-GUIDstring
Example:df7f1068-e0c3-709d-8a14-ac2af4b632f2

The GUID that identifies an identity

user-GUIDstring
Example:df7f1068-e0c3-709d-8a14-ac2af4b632aa

The GUID that identifies a user

searchstring
Example:John

Search for code and name of user

Response

Success

UserGUIDstring
IdentityGUIDstring
EmailAddressstring
Namestring
Statusstring
UserCodestring
MFAStatusstring
EmailAddressVerificationStatusstring
RoleCodestring
TeamRolesstring
MultifactorMethodstring
MultifactorStatusstring
EmailAddressVerifiedDateTimestring date-time

Example response

[
  {
    "EmailAddressVerificationStatus": "VERIFIED",
    "RoleCode": "ROLE-SITE-ADMIN/ROLE-SITE-OWNER/ROLE-USER-ADMIN/ROLE-FUND-ADMIN/CUSTOM-ROLE",
    "TeamRoles": "Daily1(Accounting),Daily2(Admin,Accounting)",
    "MultifactorMethod": "APP",
    "MultifactorStatus": "ENABLED"
  }
]

Changes

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