All URIs are relative to https://platform.devtest.ringcentral.com
| Method | HTTP request | Description |
|---|---|---|
| CheckPermission | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile/check | Check User Permissions |
| GetPermission | Get /restapi/v1.0/dictionary/permission/{permissionId} | Get Permission Info |
| GetPermissionCategory | Get /restapi/v1.0/dictionary/permission-category/{permissionCategoryId} | Get Permission Category |
| GetProfile | Get /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile | Get User Permissions |
| GetSystemRole | Get /restapi/v1.0/dictionary/user-role/{roleId} | Get User Role |
| ListPermissionCategories | Get /restapi/v1.0/dictionary/permission-category | Get Permissions Categories |
| ListPermissions | Get /restapi/v1.0/dictionary/permission | Get Permissions |
| ListSystemRoles | Get /restapi/v1.0/dictionary/user-role | Get Standard User Roles |
| LoadUserRole | Get /restapi/v1.0/account/{accountId}/user-role/default | Get Default User Role |
| UpdateUserRole | Put /restapi/v1.0/account/{accountId}/user-role/default | Set Default User Role |
AuthProfileCheckResource CheckPermission(ctx, extensionId, accountId, optional) Check User Permissions
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| extensionId | string | ||
| accountId | string | ||
| optional | *CheckPermissionOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a CheckPermissionOpts struct
| Name | Type | Description | Notes |
|---|
permissionId | optional.String| | targetExtensionId | optional.String| |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PermissionResource GetPermission(ctx, permissionId) Get Permission Info
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| permissionId | string |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PermissionCategoryResource GetPermissionCategory(ctx, permissionCategoryId) Get Permission Category
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| permissionCategoryId | string |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AuthProfileResource GetProfile(ctx, extensionId, accountId) Get User Permissions
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| extensionId | string | ||
| accountId | string |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RoleResource GetSystemRole(ctx, roleId) Get User Role
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| roleId | string |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PermissionCategoryCollectionResource ListPermissionCategories(ctx, optional) Get Permissions Categories
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ListPermissionCategoriesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListPermissionCategoriesOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| page | optional.String | [default to 1] | |
| perPage | optional.String | [default to 100] | |
| servicePlanId | optional.String |
PermissionCategoryCollectionResource
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PermissionCollectionResource ListPermissions(ctx, optional) Get Permissions
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ListPermissionsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListPermissionsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| page | optional.String | [default to 1] | |
| perPage | optional.String | [default to 100] | |
| assignable | optional.Bool | ||
| servicePlanId | optional.String |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RolesCollectionResource ListSystemRoles(ctx, optional) Get Standard User Roles
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ListSystemRolesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListSystemRolesOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| page | optional.String | [default to 1] | |
| perPage | optional.String | [default to 100] | |
| servicePlanId | optional.String |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LoadUserRole(ctx, accountId) Get Default User Role
Since 1.0.28 (Release 8.4)
Returns account default user role.
| Permission | Description |
|---|---|
| RoleManagement | Editing and assignment of user roles |
Light
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Internal identifier of an account | [default to ~] |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateUserRole(ctx, accountId, defaultUserRoleRequest) Set Default User Role
Since 1.0.30 (Release 9.1)
Updates account default user role.
| Permission | Description |
|---|---|
| RoleManagement | Editing and assignment of user roles |
Light
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Internal identifier of an account | [default to ~] |
| defaultUserRoleRequest | DefaultUserRoleRequest | JSON body |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]