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 User Permissions API

The User Permissions API from RingCentral — 6 operation(s) for user permissions.

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

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

This API exposes 6 operations across 6 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.

6 operations 6 paths 14 schemas 6 GET

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 User Permissions 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 6

Across 6 paths, the API surfaces 6 operations — 6 GET. Each is listed below with its method, path, parameters, and response codes.

User Permissions 6
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile
Get Authorization Profile
readAuthorizationProfile 3 params → 200
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile/check
Check User Permission
checkUserPermission 4 params → 200
GET
/restapi/v1.0/dictionary/permission
List Permissions
listPermissions 4 params → 200
GET
/restapi/v1.0/dictionary/permission/{permissionId}
Get Permission
readPermission 1 param → 200
GET
/restapi/v1.0/dictionary/permission-category
List Permission Categories
listPermissionCategories 3 params → 200
GET
/restapi/v1.0/dictionary/permission-category/{permissionCategoryId}
Get Permission Category
readPermissionCategory 1 param → 200

Schemas 14

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

PermissionIdResource
object
6 properties
PageNavigationUri
object
1 property
EnumeratedPagingModel
object
6 properties 1 required
RoleIdResource
object
2 properties
PermissionCategoryIdResource
object
2 properties
PermissionCollectionResource
object
4 properties
AuthProfileCheckResource
object
3 properties
PermissionCategoryCollectionResource
object
4 properties
PermissionsCapabilities
object
Advanced permissions capabilities. Returned if advancedPermissions query parameter is set to true.
3 properties
ActivePermissionResource
object
3 properties
PermissionCategoryResource
object
4 properties
PermissionResource
object
9 properties
PageNavigationModel
object
Links to other pages of the current result set
4 properties
AuthProfileResource
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-user-permissions-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