RIringcentral
Role Management

Update User Role

Updates a user role assigned to the current account by ID.

put/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)

Request body

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 request

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

Response

Updated 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.