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

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