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_sidstringformat: "uuid"
namestring
username
emailstring
user email address
is_activeenum
user account is active
Allowed values:
force_changeenum
require the user to change password on next login
Allowed values:
account_sidstringformat: "uuid"
account sid the account the user will have access to, if not set will create a Service Provider account
service_provider_sidstringformat: "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
providerenum
Allowed values:
provider_user_idstring
scopeenum
Allowed values:
phone_activation_codestring
email_activation_codestring
email_validatedenum
Allowed values:
phone_validatedenum
Allowed values:
email_content_opt_outenum
Allowed values:
pending_emailstring
phonestring

Errors

403
Forbidden Error
500
Internal Server Error