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

     1  # \RolesApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateRole**](RolesApi.md#CreateRole) | **Post** /roles | Creating a role
     8  [**GetAllRoles**](RolesApi.md#GetAllRoles) | **Get** /roles | Getting all roles
     9  [**GetRole**](RolesApi.md#GetRole) | **Get** /roles/{roleId} | Getting a role from its id
    10  [**UpdateRole**](RolesApi.md#UpdateRole) | **Put** /roles/{roleId} | Updating a role
    11  
    12  
    13  
    14  ## CreateRole
    15  
    16  > Role CreateRole(ctx, label, optional)
    17  Creating a role
    18  
    19  This method creates a new role. In case of success it renders the created role, otherwise, it renders an error (422 HTTP code).
    20  
    21  ### Required Parameters
    22  
    23  
    24  Name | Type | Description  | Notes
    25  ------------- | ------------- | ------------- | -------------
    26  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    27  **label** | **string**|  | 
    28   **optional** | ***CreateRoleOpts** | optional parameters | nil if no parameters
    29  
    30  ### Optional Parameters
    31  
    32  Optional parameters are passed through a pointer to a CreateRoleOpts struct
    33  
    34  
    35  Name | Type | Description  | Notes
    36  ------------- | ------------- | ------------- | -------------
    37  
    38   **accessHelpCenter** | **optional.Bool**|  | 
    39   **accessPreviousMessages** | **optional.Bool**|  | 
    40   **accessPullMode** | **optional.Bool**|  | 
    41   **adminStampAnswer** | **optional.Bool**|  | 
    42   **approveContent** | **optional.Bool**|  | 
    43   **assignIntervention** | **optional.Bool**|  | 
    44   **authorBlockContent** | **optional.Bool**|  | 
    45   **closeContentThread** | **optional.Bool**|  | 
    46   **createAndDestroyExtension** | **optional.Bool**|  | 
    47   **createCommunity** | **optional.Bool**|  | 
    48   **createContentSource** | **optional.Bool**|  | 
    49   **createUser** | **optional.Bool**|  | 
    50   **delayExportContent** | **optional.Bool**|  | 
    51   **deleteContentThread** | **optional.Bool**|  | 
    52   **impersonateUser** | **optional.Bool**|  | 
    53   **inviteUser** | **optional.Bool**|  | 
    54   **manageApiAccessTokens** | **optional.Bool**|  | 
    55   **manageAppSdkApplications** | **optional.Bool**|  | 
    56   **manageAutomaticExportsTasks** | **optional.Bool**| permission only available with the corresponding extension enabled | 
    57   **manageCategories** | **optional.Bool**|  | 
    58   **manageChat** | **optional.Bool**|  | 
    59   **manageCustomFields** | **optional.Bool**|  | 
    60   **manageCustomNotifications** | **optional.Bool**|  | 
    61   **manageEmailsTemplates** | **optional.Bool**|  | 
    62   **manageFolders** | **optional.Bool**|  | 
    63   **manageIce** | **optional.Bool**|  | 
    64   **manageIdentities** | **optional.Bool**|  | 
    65   **manageOwnNotifications** | **optional.Bool**|  | 
    66   **manageReplyAssistant** | **optional.Bool**| permission only available with the corresponding extension enabled | 
    67   **manageRoles** | **optional.Bool**|  | 
    68   **manageRulesEngineRules** | **optional.Bool**| permission only available with the corresponding extension enabled | 
    69   **manageSurveys** | **optional.Bool**| permission only available with the corresponding extension enabled | 
    70   **manageTags** | **optional.Bool**|  | 
    71   **manageTeams** | **optional.Bool**|  | 
    72   **manageTopologies** | **optional.Bool**|  | 
    73   **manageUsersOfMyTeams** | **optional.Bool**|  | 
    74   **monitorTasks** | **optional.Bool**|  | 
    75   **monitorTeamTasks** | **optional.Bool**|  | 
    76   **muteContent** | **optional.Bool**|  | 
    77   **openContentThread** | **optional.Bool**|  | 
    78   **publishContent** | **optional.Bool**|  | 
    79   **readCommunity** | **optional.Bool**|  | 
    80   **readContentSource** | **optional.Bool**|  | 
    81   **readEvent** | **optional.Bool**|  | 
    82   **readExport** | **optional.Bool**|  | 
    83   **readIdentity** | **optional.Bool**|  | 
    84   **readOwnStats** | **optional.Bool**|  | 
    85   **readPresence** | **optional.Bool**|  | 
    86   **readStats** | **optional.Bool**|  | 
    87   **readSurveys** | **optional.Bool**| permission only available with the corresponding extension enabled | 
    88   **readUser** | **optional.Bool**|  | 
    89   **receiveTasks** | **optional.Bool**|  | 
    90   **replyWithAssistant** | **optional.Bool**| permission only available with the corresponding extension enabled | 
    91   **searchContents** | **optional.Bool**|  | 
    92   **searchEvent** | **optional.Bool**|  | 
    93   **updateCommunity** | **optional.Bool**|  | 
    94   **updateContentSource** | **optional.Bool**|  | 
    95   **updateExtension** | **optional.Bool**|  | 
    96   **updateIdentity** | **optional.Bool**|  | 
    97   **updateIntervention** | **optional.Bool**|  | 
    98   **updateOwnIntervention** | **optional.Bool**|  | 
    99   **updateSettings** | **optional.Bool**|  | 
   100   **updateTimeSheet** | **optional.Bool**|  | 
   101   **updateUser** | **optional.Bool**|  | 
   102   **useEmoji** | **optional.Bool**|  | 
   103  
   104  ### Return type
   105  
   106  [**Role**](Role.md)
   107  
   108  ### Authorization
   109  
   110  No authorization required
   111  
   112  ### HTTP request headers
   113  
   114  - **Content-Type**: Not defined
   115  - **Accept**: application/json
   116  
   117  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   118  [[Back to Model list]](../README.md#documentation-for-models)
   119  [[Back to README]](../README.md)
   120  
   121  
   122  ## GetAllRoles
   123  
   124  > GetAllRolesResponse GetAllRoles(ctx, optional)
   125  Getting all roles
   126  
   127  This method renders roles ordered by creation date (ascending).
   128  
   129  ### Required Parameters
   130  
   131  
   132  Name | Type | Description  | Notes
   133  ------------- | ------------- | ------------- | -------------
   134  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   135   **optional** | ***GetAllRolesOpts** | optional parameters | nil if no parameters
   136  
   137  ### Optional Parameters
   138  
   139  Optional parameters are passed through a pointer to a GetAllRolesOpts struct
   140  
   141  
   142  Name | Type | Description  | Notes
   143  ------------- | ------------- | ------------- | -------------
   144   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
   145   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
   146  
   147  ### Return type
   148  
   149  [**GetAllRolesResponse**](GetAllRolesResponse.md)
   150  
   151  ### Authorization
   152  
   153  No authorization required
   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)
   161  [[Back to Model list]](../README.md#documentation-for-models)
   162  [[Back to README]](../README.md)
   163  
   164  
   165  ## GetRole
   166  
   167  > Role GetRole(ctx, roleId)
   168  Getting a role from its id
   169  
   170  This method renders a role from given id.  Authorization​: only users that can manage roles.
   171  
   172  ### Required Parameters
   173  
   174  
   175  Name | Type | Description  | Notes
   176  ------------- | ------------- | ------------- | -------------
   177  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   178  **roleId** | **string**|  | 
   179  
   180  ### Return type
   181  
   182  [**Role**](Role.md)
   183  
   184  ### Authorization
   185  
   186  No authorization required
   187  
   188  ### HTTP request headers
   189  
   190  - **Content-Type**: Not defined
   191  - **Accept**: application/json
   192  
   193  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   194  [[Back to Model list]](../README.md#documentation-for-models)
   195  [[Back to README]](../README.md)
   196  
   197  
   198  ## UpdateRole
   199  
   200  > Role UpdateRole(ctx, roleId, optional)
   201  Updating a role
   202  
   203  This method updates an existing role from given attributes and renders it in case of success.  Authorization​: A user can’t update roles with more permissions than himself and can’t give a role a permission he doesn’t have.  Any permission updated with a user that does not have this permission will be ignored (The update is done, just not the unallowed permission)
   204  
   205  ### Required Parameters
   206  
   207  
   208  Name | Type | Description  | Notes
   209  ------------- | ------------- | ------------- | -------------
   210  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   211  **roleId** | **string**|  | 
   212   **optional** | ***UpdateRoleOpts** | optional parameters | nil if no parameters
   213  
   214  ### Optional Parameters
   215  
   216  Optional parameters are passed through a pointer to a UpdateRoleOpts struct
   217  
   218  
   219  Name | Type | Description  | Notes
   220  ------------- | ------------- | ------------- | -------------
   221  
   222   **accessHelpCenter** | **optional.Bool**|  | 
   223   **accessPreviousMessages** | **optional.Bool**|  | 
   224   **accessPullMode** | **optional.Bool**|  | 
   225   **adminStampAnswer** | **optional.Bool**|  | 
   226   **approveContent** | **optional.Bool**|  | 
   227   **assignIntervention** | **optional.Bool**|  | 
   228   **authorBlockContent** | **optional.Bool**|  | 
   229   **closeContentThread** | **optional.Bool**|  | 
   230   **createAndDestroyExtension** | **optional.Bool**|  | 
   231   **createCommunity** | **optional.Bool**|  | 
   232   **createContentSource** | **optional.Bool**|  | 
   233   **createUser** | **optional.Bool**|  | 
   234   **delayExportContent** | **optional.Bool**|  | 
   235   **deleteContentThread** | **optional.Bool**|  | 
   236   **impersonateUser** | **optional.Bool**|  | 
   237   **inviteUser** | **optional.Bool**|  | 
   238   **manageApiAccessTokens** | **optional.Bool**|  | 
   239   **manageAppSdkApplications** | **optional.Bool**|  | 
   240   **manageAutomaticExportsTasks** | **optional.Bool**| permission only available with the corresponding extension enabled | 
   241   **manageCategories** | **optional.Bool**|  | 
   242   **manageChat** | **optional.Bool**|  | 
   243   **manageCustomFields** | **optional.Bool**|  | 
   244   **manageCustomNotifications** | **optional.Bool**|  | 
   245   **manageEmailsTemplates** | **optional.Bool**|  | 
   246   **manageFolders** | **optional.Bool**|  | 
   247   **manageIce** | **optional.Bool**|  | 
   248   **manageIdentities** | **optional.Bool**|  | 
   249   **manageOwnNotifications** | **optional.Bool**|  | 
   250   **manageReplyAssistant** | **optional.Bool**| permission only available with the corresponding extension enabled | 
   251   **manageRoles** | **optional.Bool**|  | 
   252   **manageRulesEngineRules** | **optional.Bool**| permission only available with the corresponding extension enabled | 
   253   **manageSurveys** | **optional.Bool**| permission only available with the corresponding extension enabled | 
   254   **manageTags** | **optional.Bool**|  | 
   255   **manageTeams** | **optional.Bool**|  | 
   256   **manageTopologies** | **optional.Bool**|  | 
   257   **manageUsersOfMyTeams** | **optional.Bool**|  | 
   258   **monitorTasks** | **optional.Bool**|  | 
   259   **monitorTeamTasks** | **optional.Bool**|  | 
   260   **muteContent** | **optional.Bool**|  | 
   261   **openContentThread** | **optional.Bool**|  | 
   262   **publishContent** | **optional.Bool**|  | 
   263   **readCommunity** | **optional.Bool**|  | 
   264   **readContentSource** | **optional.Bool**|  | 
   265   **readEvent** | **optional.Bool**|  | 
   266   **readExport** | **optional.Bool**|  | 
   267   **readIdentity** | **optional.Bool**|  | 
   268   **readOwnStats** | **optional.Bool**|  | 
   269   **readPresence** | **optional.Bool**|  | 
   270   **readStats** | **optional.Bool**|  | 
   271   **readSurveys** | **optional.Bool**| permission only available with the corresponding extension enabled | 
   272   **readUser** | **optional.Bool**|  | 
   273   **receiveTasks** | **optional.Bool**|  | 
   274   **replyWithAssistant** | **optional.Bool**| permission only available with the corresponding extension enabled | 
   275   **searchContents** | **optional.Bool**|  | 
   276   **searchEvent** | **optional.Bool**|  | 
   277   **updateCommunity** | **optional.Bool**|  | 
   278   **updateContentSource** | **optional.Bool**|  | 
   279   **updateExtension** | **optional.Bool**|  | 
   280   **updateIdentity** | **optional.Bool**|  | 
   281   **updateIntervention** | **optional.Bool**|  | 
   282   **updateOwnIntervention** | **optional.Bool**|  | 
   283   **updateSettings** | **optional.Bool**|  | 
   284   **updateTimeSheet** | **optional.Bool**|  | 
   285   **updateUser** | **optional.Bool**|  | 
   286   **useEmoji** | **optional.Bool**|  | 
   287  
   288  ### Return type
   289  
   290  [**Role**](Role.md)
   291  
   292  ### Authorization
   293  
   294  No authorization required
   295  
   296  ### HTTP request headers
   297  
   298  - **Content-Type**: Not defined
   299  - **Accept**: application/json
   300  
   301  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   302  [[Back to Model list]](../README.md#documentation-for-models)
   303  [[Back to README]](../README.md)
   304