github.com/twilio/twilio-go@v1.20.1/rest/conversations/v1/docs/ServicesRolesApi.md (about)

     1  # ServicesRolesApi
     2  
     3  All URIs are relative to *https://conversations.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateServiceRole**](ServicesRolesApi.md#CreateServiceRole) | **Post** /v1/Services/{ChatServiceSid}/Roles | 
     8  [**DeleteServiceRole**](ServicesRolesApi.md#DeleteServiceRole) | **Delete** /v1/Services/{ChatServiceSid}/Roles/{Sid} | 
     9  [**FetchServiceRole**](ServicesRolesApi.md#FetchServiceRole) | **Get** /v1/Services/{ChatServiceSid}/Roles/{Sid} | 
    10  [**ListServiceRole**](ServicesRolesApi.md#ListServiceRole) | **Get** /v1/Services/{ChatServiceSid}/Roles | 
    11  [**UpdateServiceRole**](ServicesRolesApi.md#UpdateServiceRole) | **Post** /v1/Services/{ChatServiceSid}/Roles/{Sid} | 
    12  
    13  
    14  
    15  ## CreateServiceRole
    16  
    17  > ConversationsV1ServiceRole CreateServiceRole(ctx, ChatServiceSidoptional)
    18  
    19  
    20  
    21  Create a new user role in your service
    22  
    23  ### Path Parameters
    24  
    25  
    26  Name | Type | Description
    27  ------------- | ------------- | -------------
    28  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    29  **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to create the Role resource under.
    30  
    31  ### Other Parameters
    32  
    33  Other parameters are passed through a pointer to a CreateServiceRoleParams struct
    34  
    35  
    36  Name | Type | Description
    37  ------------- | ------------- | -------------
    38  **FriendlyName** | **string** | A descriptive string that you create to describe the new resource. It can be up to 64 characters long.
    39  **Type** | **string** | 
    40  **Permission** | **[]string** | A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type`.
    41  
    42  ### Return type
    43  
    44  [**ConversationsV1ServiceRole**](ConversationsV1ServiceRole.md)
    45  
    46  ### Authorization
    47  
    48  [accountSid_authToken](../README.md#accountSid_authToken)
    49  
    50  ### HTTP request headers
    51  
    52  - **Content-Type**: application/x-www-form-urlencoded
    53  - **Accept**: application/json
    54  
    55  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    56  [[Back to Model list]](../README.md#documentation-for-models)
    57  [[Back to README]](../README.md)
    58  
    59  
    60  ## DeleteServiceRole
    61  
    62  > DeleteServiceRole(ctx, ChatServiceSidSid)
    63  
    64  
    65  
    66  Remove a user role from your service
    67  
    68  ### Path Parameters
    69  
    70  
    71  Name | Type | Description
    72  ------------- | ------------- | -------------
    73  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    74  **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the Role resource from.
    75  **Sid** | **string** | The SID of the Role resource to delete.
    76  
    77  ### Other Parameters
    78  
    79  Other parameters are passed through a pointer to a DeleteServiceRoleParams struct
    80  
    81  
    82  Name | Type | Description
    83  ------------- | ------------- | -------------
    84  
    85  ### Return type
    86  
    87   (empty response body)
    88  
    89  ### Authorization
    90  
    91  [accountSid_authToken](../README.md#accountSid_authToken)
    92  
    93  ### HTTP request headers
    94  
    95  - **Content-Type**: Not defined
    96  - **Accept**: Not defined
    97  
    98  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    99  [[Back to Model list]](../README.md#documentation-for-models)
   100  [[Back to README]](../README.md)
   101  
   102  
   103  ## FetchServiceRole
   104  
   105  > ConversationsV1ServiceRole FetchServiceRole(ctx, ChatServiceSidSid)
   106  
   107  
   108  
   109  Fetch a user role from your service
   110  
   111  ### Path Parameters
   112  
   113  
   114  Name | Type | Description
   115  ------------- | ------------- | -------------
   116  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   117  **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to fetch the Role resource from.
   118  **Sid** | **string** | The SID of the Role resource to fetch.
   119  
   120  ### Other Parameters
   121  
   122  Other parameters are passed through a pointer to a FetchServiceRoleParams struct
   123  
   124  
   125  Name | Type | Description
   126  ------------- | ------------- | -------------
   127  
   128  ### Return type
   129  
   130  [**ConversationsV1ServiceRole**](ConversationsV1ServiceRole.md)
   131  
   132  ### Authorization
   133  
   134  [accountSid_authToken](../README.md#accountSid_authToken)
   135  
   136  ### HTTP request headers
   137  
   138  - **Content-Type**: Not defined
   139  - **Accept**: application/json
   140  
   141  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   142  [[Back to Model list]](../README.md#documentation-for-models)
   143  [[Back to README]](../README.md)
   144  
   145  
   146  ## ListServiceRole
   147  
   148  > []ConversationsV1ServiceRole ListServiceRole(ctx, ChatServiceSidoptional)
   149  
   150  
   151  
   152  Retrieve a list of all user roles in your service
   153  
   154  ### Path Parameters
   155  
   156  
   157  Name | Type | Description
   158  ------------- | ------------- | -------------
   159  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   160  **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to read the Role resources from.
   161  
   162  ### Other Parameters
   163  
   164  Other parameters are passed through a pointer to a ListServiceRoleParams struct
   165  
   166  
   167  Name | Type | Description
   168  ------------- | ------------- | -------------
   169  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   170  **Limit** | **int** | Max number of records to return.
   171  
   172  ### Return type
   173  
   174  [**[]ConversationsV1ServiceRole**](ConversationsV1ServiceRole.md)
   175  
   176  ### Authorization
   177  
   178  [accountSid_authToken](../README.md#accountSid_authToken)
   179  
   180  ### HTTP request headers
   181  
   182  - **Content-Type**: Not defined
   183  - **Accept**: application/json
   184  
   185  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   186  [[Back to Model list]](../README.md#documentation-for-models)
   187  [[Back to README]](../README.md)
   188  
   189  
   190  ## UpdateServiceRole
   191  
   192  > ConversationsV1ServiceRole UpdateServiceRole(ctx, ChatServiceSidSidoptional)
   193  
   194  
   195  
   196  Update an existing user role in your service
   197  
   198  ### Path Parameters
   199  
   200  
   201  Name | Type | Description
   202  ------------- | ------------- | -------------
   203  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   204  **ChatServiceSid** | **string** | The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to update the Role resource in.
   205  **Sid** | **string** | The SID of the Role resource to update.
   206  
   207  ### Other Parameters
   208  
   209  Other parameters are passed through a pointer to a UpdateServiceRoleParams struct
   210  
   211  
   212  Name | Type | Description
   213  ------------- | ------------- | -------------
   214  **Permission** | **[]string** | A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role's `type`.
   215  
   216  ### Return type
   217  
   218  [**ConversationsV1ServiceRole**](ConversationsV1ServiceRole.md)
   219  
   220  ### Authorization
   221  
   222  [accountSid_authToken](../README.md#accountSid_authToken)
   223  
   224  ### HTTP request headers
   225  
   226  - **Content-Type**: application/x-www-form-urlencoded
   227  - **Accept**: application/json
   228  
   229  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   230  [[Back to Model list]](../README.md#documentation-for-models)
   231  [[Back to README]](../README.md)
   232