Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral Role Management API

The Role Management API from RingCentral — 10 operation(s) for role management.

RingCentral Role Management API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Role Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 15 operations across 10 paths, and defines 14 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

15 operations 10 paths 14 schemas 1 DELETE8 GET2 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Role Management API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 15

Across 10 paths, the API surfaces 15 operations — 1 DELETE, 8 GET, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Role Management 15
GET
/restapi/v1.0/account/{accountId}/assigned-role
List Company Assigned Roles
listAssignedRoles 2 params → 200
GET
/restapi/v1.0/account/{accountId}/user-role
List Company User Roles
listUserRoles 4 params → 200
POST
/restapi/v1.0/account/{accountId}/user-role
Create Custom Role
createCustomRole 1 param body → 200
GET
/restapi/v1.0/account/{accountId}/user-role/default
Get Default User Role
readDefaultRole 1 param → 200
PUT
/restapi/v1.0/account/{accountId}/user-role/default
Set Default User Role
updateDefaultUserRole 1 param body → 200
GET
/restapi/v1.0/account/{accountId}/user-role/{roleId}
Get User Role
readUserRole 3 params → 200
PUT
/restapi/v1.0/account/{accountId}/user-role/{roleId}
Update User Role
updateUserRole 2 params body → 200
DELETE
/restapi/v1.0/account/{accountId}/user-role/{roleId}
Delete Custom Role
deleteCustomRole 3 params → 204
POST
/restapi/v1.0/account/{accountId}/user-role/{roleId}/bulk-assign
Assign Multiple User Roles
assignMultipleUserRoles 2 params body → 200
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/assignable-roles
List Assignable Roles
listOfAvailableForAssigningRoles 4 params → 200
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/assigned-role
List User Assigned Roles
listUserAssignedRoles 3 params → 200
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/assigned-role
Update User Assigned Roles
updateUserAssignedRoles 2 params body → 200
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/assigned-role/default
Assign Default Role
assignDefaultRole 2 params → 200
GET
/restapi/v1.0/dictionary/user-role
List Standard User Roles
listStandardUserRole 4 params → 200
GET
/restapi/v1.0/dictionary/user-role/{roleId}
Get Standard User Role
readStandardUserRole 1 param → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are RoleResource (10 properties), PermissionIdResource (6 properties), EnumeratedPagingModel (6 properties), AssignedRoleResource (6 properties). Each schema is shown below with its type and property counts.

PermissionIdResource
object
6 properties
ExtensionWithRolesCollectionResource
object
4 properties
EnumeratedPagingModel
object
6 properties 1 required
PageNavigationUri
object
1 property
DefaultUserRoleRequest
object
1 property
AssignedRolesResource
object
2 properties
ExtensionWithRolesResource
object
3 properties
AssignedRoleResource
object
6 properties
PermissionsCapabilities
object
Advanced permissions capabilities. Returned if advancedPermissions query parameter is set to true.
3 properties
RolesCollectionResource
object
4 properties
DefaultUserRole
object
3 properties
PageNavigationModel
object
Links to other pages of the current result set
4 properties
RoleResource
object
10 properties
BulkRoleAssignResource
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-role-management-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API