Users

Get the detail for the user

get/sites/{site-identifier}/users/{user-guid}

Request

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

user-guidstring required

The GUID that identifies a user

Response

Success

UserGUIDstring guid
IdentityGUIDstring guid
EmailAddressstring
Namestring
Statusstring
UserCodestring
MFAStatusstring
EmailAddressVerificationStatusstring
RoleCodestring
WorkPhoneNumberstring

Example response

{
  "UserGUID": "b0c21331-6e4d-d18f-8a14-3a410c693640",
  "IdentityGUID": "cc7791ca-f564-659c-8114-2e8f51c97f0a",
  "EmailAddress": "abc@gmail.com",
  "Name": "Antony",
  "Status": "ACTIVE",
  "MFAStatus": "ACTIVE",
  "EmailAddressVerificationStatus": "VERIFIED",
  "RoleCode": "ROLE-SITE-ADMIN/ROLE-SITE-OWNER/ROLE-USER-ADMIN/ROLE-FUND-ADMIN/CUSTOM-ROLE",
  "WorkPhoneNumber": "0700000000",
  "Policies": [
    {
      "Description": "Electronically lodge via SBR (Standard Business Reporting)",
      "Value": "Deny"
    }
  ]
}

Changes

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