Skip to navigation
REST Platform ManagementUsers

retrieve user information

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

UserSidstringRequired

Response

user information
user_sidstringOptionalformat: "uuid"
namestringOptional
username
emailstringOptional
user email address
is_activeenumOptional
user account is active
Allowed values:
force_changeenumOptional
require the user to change password on next login
Allowed values:
account_sidstringOptionalformat: "uuid"
account sid the account the user will have access to, if not set will create a Service Provider account
service_provider_sidstringOptionalformat: "uuid"
The service provider sid, the account is under, if not set account will be admin level
is_view_onlybooleanOptional
If set to true the user will not be able to make changes
providerenumOptional
Allowed values:
provider_user_idstringOptional
scopeenumOptional
Allowed values:
phone_activation_codestringOptional
email_activation_codestringOptional
email_validatedenumOptional
Allowed values:
phone_validatedenumOptional
Allowed values:
email_content_opt_outenumOptional
Allowed values:
pending_emailstringOptional
phonestringOptional

Errors

403
Forbidden Error
500
Internal Server Error