retrieve user information

GET

https://api.jambonz.cloud/v1/Users/:UserSid

AuthorizationBearer

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

UserSidstringRequired

user information

user_sidstringOptionalformat: "uuid"

namestringOptional

username

emailstringOptional

user email address

is_activeenumOptional

user account is active

force_changeenumOptional

require the user to change password on next login

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

provider_user_idstringOptional

scopeenumOptional

phone_activation_codestringOptional

email_activation_codestringOptional

email_validatedenumOptional

phone_validatedenumOptional

email_content_opt_outenumOptional

pending_emailstringOptional

phonestringOptional

403

Forbidden Error

500

Internal Server Error

1	{
2	"user_sid": "58b8ec3a-6fcc-4fd7-8f45-cff054c2ebe9",
3	"name": "jdoe",
4	"email": "jdoe@example.com",
5	"is_active": 1,
6	"force_change": 0,
7	"account_sid": "a3f1c2d4-5678-4b9a-9cde-123456789abc",
8	"service_provider_sid": "b7e2d3f5-1234-4a6b-8cde-987654321def",
9	"is_view_only": false,
10	"provider": "local",
11	"provider_user_id": "jdoe123",
12	"scope": "read-write",
13	"phone_activation_code": "839201",
14	"email_activation_code": "4f7a9c",
15	"email_validated": 1,
16	"phone_validated": 0,
17	"email_content_opt_out": 0,
18	"pending_email": "pending_change@example.com",
19	"phone": "+14155552671"
20	}

$	curl https://api.jambonz.cloud/v1/Users/UserSid \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"