github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/RolesAndPermissionsApi.md (about)

     1  # \RolesAndPermissionsApi
     2  
     3  All URIs are relative to *https://platform.devtest.ringcentral.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CheckPermission**](RolesAndPermissionsApi.md#CheckPermission) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile/check | Check User Permissions
     8  [**GetPermission**](RolesAndPermissionsApi.md#GetPermission) | **Get** /restapi/v1.0/dictionary/permission/{permissionId} | Get Permission Info
     9  [**GetPermissionCategory**](RolesAndPermissionsApi.md#GetPermissionCategory) | **Get** /restapi/v1.0/dictionary/permission-category/{permissionCategoryId} | Get Permission Category
    10  [**GetProfile**](RolesAndPermissionsApi.md#GetProfile) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile | Get User Permissions
    11  [**GetSystemRole**](RolesAndPermissionsApi.md#GetSystemRole) | **Get** /restapi/v1.0/dictionary/user-role/{roleId} | Get User Role
    12  [**ListPermissionCategories**](RolesAndPermissionsApi.md#ListPermissionCategories) | **Get** /restapi/v1.0/dictionary/permission-category | Get Permissions Categories
    13  [**ListPermissions**](RolesAndPermissionsApi.md#ListPermissions) | **Get** /restapi/v1.0/dictionary/permission | Get Permissions
    14  [**ListSystemRoles**](RolesAndPermissionsApi.md#ListSystemRoles) | **Get** /restapi/v1.0/dictionary/user-role | Get Standard User Roles
    15  [**LoadUserRole**](RolesAndPermissionsApi.md#LoadUserRole) | **Get** /restapi/v1.0/account/{accountId}/user-role/default | Get Default User Role
    16  [**UpdateUserRole**](RolesAndPermissionsApi.md#UpdateUserRole) | **Put** /restapi/v1.0/account/{accountId}/user-role/default | Set Default User Role
    17  
    18  
    19  # **CheckPermission**
    20  > AuthProfileCheckResource CheckPermission(ctx, extensionId, accountId, optional)
    21  Check User Permissions
    22  
    23  ### Required Parameters
    24  
    25  Name | Type | Description  | Notes
    26  ------------- | ------------- | ------------- | -------------
    27   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    28    **extensionId** | **string**|  | 
    29    **accountId** | **string**|  | 
    30   **optional** | ***CheckPermissionOpts** | optional parameters | nil if no parameters
    31  
    32  ### Optional Parameters
    33  Optional parameters are passed through a pointer to a CheckPermissionOpts struct
    34  
    35  Name | Type | Description  | Notes
    36  ------------- | ------------- | ------------- | -------------
    37  
    38  
    39   **permissionId** | **optional.String**|  | 
    40   **targetExtensionId** | **optional.String**|  | 
    41  
    42  ### Return type
    43  
    44  [**AuthProfileCheckResource**](AuthProfileCheckResource.md)
    45  
    46  ### Authorization
    47  
    48  [OAuth2](../README.md#OAuth2)
    49  
    50  ### HTTP request headers
    51  
    52   - **Content-Type**: Not defined
    53   - **Accept**: application/json
    54  
    55  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    56  
    57  # **GetPermission**
    58  > PermissionResource GetPermission(ctx, permissionId)
    59  Get Permission Info
    60  
    61  ### Required Parameters
    62  
    63  Name | Type | Description  | Notes
    64  ------------- | ------------- | ------------- | -------------
    65   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    66    **permissionId** | **string**|  | 
    67  
    68  ### Return type
    69  
    70  [**PermissionResource**](PermissionResource.md)
    71  
    72  ### Authorization
    73  
    74  [OAuth2](../README.md#OAuth2)
    75  
    76  ### HTTP request headers
    77  
    78   - **Content-Type**: Not defined
    79   - **Accept**: application/json
    80  
    81  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    82  
    83  # **GetPermissionCategory**
    84  > PermissionCategoryResource GetPermissionCategory(ctx, permissionCategoryId)
    85  Get Permission Category
    86  
    87  ### Required Parameters
    88  
    89  Name | Type | Description  | Notes
    90  ------------- | ------------- | ------------- | -------------
    91   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    92    **permissionCategoryId** | **string**|  | 
    93  
    94  ### Return type
    95  
    96  [**PermissionCategoryResource**](PermissionCategoryResource.md)
    97  
    98  ### Authorization
    99  
   100  [OAuth2](../README.md#OAuth2)
   101  
   102  ### HTTP request headers
   103  
   104   - **Content-Type**: Not defined
   105   - **Accept**: application/json
   106  
   107  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   108  
   109  # **GetProfile**
   110  > AuthProfileResource GetProfile(ctx, extensionId, accountId)
   111  Get User Permissions
   112  
   113  ### Required Parameters
   114  
   115  Name | Type | Description  | Notes
   116  ------------- | ------------- | ------------- | -------------
   117   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   118    **extensionId** | **string**|  | 
   119    **accountId** | **string**|  | 
   120  
   121  ### Return type
   122  
   123  [**AuthProfileResource**](AuthProfileResource.md)
   124  
   125  ### Authorization
   126  
   127  [OAuth2](../README.md#OAuth2)
   128  
   129  ### HTTP request headers
   130  
   131   - **Content-Type**: Not defined
   132   - **Accept**: application/json
   133  
   134  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   135  
   136  # **GetSystemRole**
   137  > RoleResource GetSystemRole(ctx, roleId)
   138  Get User Role
   139  
   140  ### Required Parameters
   141  
   142  Name | Type | Description  | Notes
   143  ------------- | ------------- | ------------- | -------------
   144   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   145    **roleId** | **string**|  | 
   146  
   147  ### Return type
   148  
   149  [**RoleResource**](RoleResource.md)
   150  
   151  ### Authorization
   152  
   153  [OAuth2](../README.md#OAuth2)
   154  
   155  ### HTTP request headers
   156  
   157   - **Content-Type**: Not defined
   158   - **Accept**: application/json
   159  
   160  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   161  
   162  # **ListPermissionCategories**
   163  > PermissionCategoryCollectionResource ListPermissionCategories(ctx, optional)
   164  Get Permissions Categories
   165  
   166  ### Required Parameters
   167  
   168  Name | Type | Description  | Notes
   169  ------------- | ------------- | ------------- | -------------
   170   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   171   **optional** | ***ListPermissionCategoriesOpts** | optional parameters | nil if no parameters
   172  
   173  ### Optional Parameters
   174  Optional parameters are passed through a pointer to a ListPermissionCategoriesOpts struct
   175  
   176  Name | Type | Description  | Notes
   177  ------------- | ------------- | ------------- | -------------
   178   **page** | **optional.String**|  | [default to 1]
   179   **perPage** | **optional.String**|  | [default to 100]
   180   **servicePlanId** | **optional.String**|  | 
   181  
   182  ### Return type
   183  
   184  [**PermissionCategoryCollectionResource**](PermissionCategoryCollectionResource.md)
   185  
   186  ### Authorization
   187  
   188  [OAuth2](../README.md#OAuth2)
   189  
   190  ### HTTP request headers
   191  
   192   - **Content-Type**: Not defined
   193   - **Accept**: application/json
   194  
   195  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   196  
   197  # **ListPermissions**
   198  > PermissionCollectionResource ListPermissions(ctx, optional)
   199  Get Permissions
   200  
   201  ### Required Parameters
   202  
   203  Name | Type | Description  | Notes
   204  ------------- | ------------- | ------------- | -------------
   205   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   206   **optional** | ***ListPermissionsOpts** | optional parameters | nil if no parameters
   207  
   208  ### Optional Parameters
   209  Optional parameters are passed through a pointer to a ListPermissionsOpts struct
   210  
   211  Name | Type | Description  | Notes
   212  ------------- | ------------- | ------------- | -------------
   213   **page** | **optional.String**|  | [default to 1]
   214   **perPage** | **optional.String**|  | [default to 100]
   215   **assignable** | **optional.Bool**|  | 
   216   **servicePlanId** | **optional.String**|  | 
   217  
   218  ### Return type
   219  
   220  [**PermissionCollectionResource**](PermissionCollectionResource.md)
   221  
   222  ### Authorization
   223  
   224  [OAuth2](../README.md#OAuth2)
   225  
   226  ### HTTP request headers
   227  
   228   - **Content-Type**: Not defined
   229   - **Accept**: application/json
   230  
   231  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   232  
   233  # **ListSystemRoles**
   234  > RolesCollectionResource ListSystemRoles(ctx, optional)
   235  Get Standard User Roles
   236  
   237  ### Required Parameters
   238  
   239  Name | Type | Description  | Notes
   240  ------------- | ------------- | ------------- | -------------
   241   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   242   **optional** | ***ListSystemRolesOpts** | optional parameters | nil if no parameters
   243  
   244  ### Optional Parameters
   245  Optional parameters are passed through a pointer to a ListSystemRolesOpts struct
   246  
   247  Name | Type | Description  | Notes
   248  ------------- | ------------- | ------------- | -------------
   249   **page** | **optional.String**|  | [default to 1]
   250   **perPage** | **optional.String**|  | [default to 100]
   251   **servicePlanId** | **optional.String**|  | 
   252  
   253  ### Return type
   254  
   255  [**RolesCollectionResource**](RolesCollectionResource.md)
   256  
   257  ### Authorization
   258  
   259  [OAuth2](../README.md#OAuth2)
   260  
   261  ### HTTP request headers
   262  
   263   - **Content-Type**: Not defined
   264   - **Accept**: application/json
   265  
   266  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   267  
   268  # **LoadUserRole**
   269  > LoadUserRole(ctx, accountId)
   270  Get Default User Role
   271  
   272  <p style='font-style:italic;'>Since 1.0.28 (Release 8.4)</p><p>Returns account default user role.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RoleManagement</td><td>Editing and assignment of user roles</td></tr></tbody></table><h4>API Group</h4><p>Light</p>
   273  
   274  ### Required Parameters
   275  
   276  Name | Type | Description  | Notes
   277  ------------- | ------------- | ------------- | -------------
   278   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   279    **accountId** | **string**| Internal identifier of an account | [default to ~]
   280  
   281  ### Return type
   282  
   283   (empty response body)
   284  
   285  ### Authorization
   286  
   287  [OAuth2](../README.md#OAuth2)
   288  
   289  ### HTTP request headers
   290  
   291   - **Content-Type**: Not defined
   292   - **Accept**: Not defined
   293  
   294  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   295  
   296  # **UpdateUserRole**
   297  > UpdateUserRole(ctx, accountId, defaultUserRoleRequest)
   298  Set Default User Role
   299  
   300  <p style='font-style:italic;'>Since 1.0.30 (Release 9.1)</p><p>Updates account default user role.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>RoleManagement</td><td>Editing and assignment of user roles</td></tr></tbody></table><h4>API Group</h4><p>Light</p>
   301  
   302  ### Required Parameters
   303  
   304  Name | Type | Description  | Notes
   305  ------------- | ------------- | ------------- | -------------
   306   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   307    **accountId** | **string**| Internal identifier of an account | [default to ~]
   308    **defaultUserRoleRequest** | [**DefaultUserRoleRequest**](DefaultUserRoleRequest.md)| JSON body | 
   309  
   310  ### Return type
   311  
   312   (empty response body)
   313  
   314  ### Authorization
   315  
   316  [OAuth2](../README.md#OAuth2)
   317  
   318  ### HTTP request headers
   319  
   320   - **Content-Type**: application/json
   321   - **Accept**: Not defined
   322  
   323  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   324