REST Platform ManagementUsers

retrieve user information

Path parameters

UserSidstringRequired

Headers

AuthorizationstringRequired

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

Response

user information
user_sidstring or nullformat: "uuid"
namestring or null
username
emailstring or null
user email address
is_activeenum or null
user account is active
Allowed values:
force_changeenum or null
require the user to change password on next login
Allowed values:
account_sidstring or nullformat: "uuid"
account sid the account the user will have access to, if not set will create a Service Provider account
service_provider_sidstring or nullformat: "uuid"
The service provider sid, the account is under, if not set account will be admin level
is_view_onlyboolean or null
If set to true the user will not be able to make changes
providerenum or null
Allowed values:
provider_user_idstring or null
scopeenum or null
Allowed values:
phone_activation_codestring or null
email_activation_codestring or null
email_validatedenum or null
Allowed values:
phone_validatedenum or null
Allowed values:
email_content_opt_outenum or null
Allowed values:
pending_emailstring or null
phonestring or null

Errors