Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1410161228.2 KB

Fetch a user role from your account's default service

get/v1/Roles/{Sid}

Path parameters

Sidstring required

The SID of the Role resource to fetch.

Response

OK

account_sidstring nullable

The SID of the Account that created the Role resource.

chat_service_sidstring nullable

The SID of the Conversation Service the Role resource is associated with.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

friendly_namestring nullable

The string that you assigned to describe the resource.

permissionsstring[] nullable

An array of the permissions the role has been granted.

sidstring nullable

The unique string that we created to identify the Role resource.

type'conversation' | 'service'
urlstring uri nullable

An absolute API resource URL for this user role.