v27

latestOpenAPI 3.0.0MITraw.githubusercontent.com2025-11-2810941146.5 KB

Users

retrieve user information

get/Users/{UserSid}

user information

user_sidstring uuid

namestring

username

emailstring

user email address

is_active0 | 1

user account is active

force_change0 | 1

require the user to change password on next login

account_sidstring uuid

account sid the account the user will have access to, if not set will create a Service Provider account

service_provider_sidstring uuid

The service provider sid, the account is under, if not set account will be admin level

is_view_onlyboolean

If set to true the user will not be able to make changes

provider'local'

provider_user_idstring

scope'read-write'

phone_activation_codestring

email_activation_codestring

email_validated0 | 1

phone_validated0 | 1

email_content_opt_out0 | 1

pending_emailstring

phonestring

{
  "user_sid": "58b8ec3a-6fcc-4fd7-8f45-cff054c2ebe9",
  "name": "my_user",
  "email": "user@example.com"
}