RIringcentral
Role Management

Get User Role

Returns a user role assigned to the current account.

get/restapi/v1.0/account/{accountId}/user-role/{roleId}

Request

Path parameters

roleIdstring required

Internal identifier of a role

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

Query parameters

advancedPermissionsboolean

Specifies whether to return advanced permissions capabilities within permissionsCapabilities resource. The default value is false.

Response

User role information

uristring uri

Link to a role resource

idstring

Internal identifier of a role

displayNamestring

Dispayed name of a role

descriptionstring

Role description

siteCompatibleboolean

Site compatibility of a user role

customboolean

Specifies if a user role is custom

scope'Account' | 'AllExtensions' | 'Federation' | 'Group' | 'NonUserExtensions' | 'RoleBased' | 'Self' | 'UserExtensions'

Specifies resource for permission

hiddenboolean
lastUpdatedstring date-time

Example response

{
  "displayName": "Super Admin",
  "description": "Primary company administrator role"
}

Changes

No recorded changes to this operation across all 1 revision of this API.