github.com/twilio/twilio-go@v1.20.1/rest/api/v2010/docs/AccountsSIPDomainsAuthCallsCredentialListMappingsApi.md (about)

     1  # AccountsSIPDomainsAuthCallsCredentialListMappingsApi
     2  
     3  All URIs are relative to *https://api.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateSipAuthCallsCredentialListMapping**](AccountsSIPDomainsAuthCallsCredentialListMappingsApi.md#CreateSipAuthCallsCredentialListMapping) | **Post** /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json | 
     8  [**DeleteSipAuthCallsCredentialListMapping**](AccountsSIPDomainsAuthCallsCredentialListMappingsApi.md#DeleteSipAuthCallsCredentialListMapping) | **Delete** /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json | 
     9  [**FetchSipAuthCallsCredentialListMapping**](AccountsSIPDomainsAuthCallsCredentialListMappingsApi.md#FetchSipAuthCallsCredentialListMapping) | **Get** /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json | 
    10  [**ListSipAuthCallsCredentialListMapping**](AccountsSIPDomainsAuthCallsCredentialListMappingsApi.md#ListSipAuthCallsCredentialListMapping) | **Get** /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json | 
    11  
    12  
    13  
    14  ## CreateSipAuthCallsCredentialListMapping
    15  
    16  > ApiV2010SipAuthCallsCredentialListMapping CreateSipAuthCallsCredentialListMapping(ctx, DomainSidoptional)
    17  
    18  
    19  
    20  Create a new credential list mapping resource
    21  
    22  ### Path Parameters
    23  
    24  
    25  Name | Type | Description
    26  ------------- | ------------- | -------------
    27  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    28  **DomainSid** | **string** | The SID of the SIP domain that will contain the new resource.
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a CreateSipAuthCallsCredentialListMappingParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.
    38  **CredentialListSid** | **string** | The SID of the CredentialList resource to map to the SIP domain.
    39  
    40  ### Return type
    41  
    42  [**ApiV2010SipAuthCallsCredentialListMapping**](ApiV2010SipAuthCallsCredentialListMapping.md)
    43  
    44  ### Authorization
    45  
    46  [accountSid_authToken](../README.md#accountSid_authToken)
    47  
    48  ### HTTP request headers
    49  
    50  - **Content-Type**: application/x-www-form-urlencoded
    51  - **Accept**: application/json
    52  
    53  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    54  [[Back to Model list]](../README.md#documentation-for-models)
    55  [[Back to README]](../README.md)
    56  
    57  
    58  ## DeleteSipAuthCallsCredentialListMapping
    59  
    60  > DeleteSipAuthCallsCredentialListMapping(ctx, DomainSidSidoptional)
    61  
    62  
    63  
    64  Delete a credential list mapping from the requested domain
    65  
    66  ### Path Parameters
    67  
    68  
    69  Name | Type | Description
    70  ------------- | ------------- | -------------
    71  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    72  **DomainSid** | **string** | The SID of the SIP domain that contains the resource to delete.
    73  **Sid** | **string** | The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete.
    74  
    75  ### Other Parameters
    76  
    77  Other parameters are passed through a pointer to a DeleteSipAuthCallsCredentialListMappingParams struct
    78  
    79  
    80  Name | Type | Description
    81  ------------- | ------------- | -------------
    82  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resources to delete.
    83  
    84  ### Return type
    85  
    86   (empty response body)
    87  
    88  ### Authorization
    89  
    90  [accountSid_authToken](../README.md#accountSid_authToken)
    91  
    92  ### HTTP request headers
    93  
    94  - **Content-Type**: Not defined
    95  - **Accept**: Not defined
    96  
    97  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    98  [[Back to Model list]](../README.md#documentation-for-models)
    99  [[Back to README]](../README.md)
   100  
   101  
   102  ## FetchSipAuthCallsCredentialListMapping
   103  
   104  > ApiV2010SipAuthCallsCredentialListMapping FetchSipAuthCallsCredentialListMapping(ctx, DomainSidSidoptional)
   105  
   106  
   107  
   108  Fetch a specific instance of a credential list mapping
   109  
   110  ### Path Parameters
   111  
   112  
   113  Name | Type | Description
   114  ------------- | ------------- | -------------
   115  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   116  **DomainSid** | **string** | The SID of the SIP domain that contains the resource to fetch.
   117  **Sid** | **string** | The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch.
   118  
   119  ### Other Parameters
   120  
   121  Other parameters are passed through a pointer to a FetchSipAuthCallsCredentialListMappingParams struct
   122  
   123  
   124  Name | Type | Description
   125  ------------- | ------------- | -------------
   126  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resource to fetch.
   127  
   128  ### Return type
   129  
   130  [**ApiV2010SipAuthCallsCredentialListMapping**](ApiV2010SipAuthCallsCredentialListMapping.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  ## ListSipAuthCallsCredentialListMapping
   147  
   148  > []ApiV2010SipAuthCallsCredentialListMapping ListSipAuthCallsCredentialListMapping(ctx, DomainSidoptional)
   149  
   150  
   151  
   152  Retrieve a list of credential list mappings belonging to the domain used in the request
   153  
   154  ### Path Parameters
   155  
   156  
   157  Name | Type | Description
   158  ------------- | ------------- | -------------
   159  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   160  **DomainSid** | **string** | The SID of the SIP domain that contains the resources to read.
   161  
   162  ### Other Parameters
   163  
   164  Other parameters are passed through a pointer to a ListSipAuthCallsCredentialListMappingParams struct
   165  
   166  
   167  Name | Type | Description
   168  ------------- | ------------- | -------------
   169  **PathAccountSid** | **string** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resources to read.
   170  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   171  **Limit** | **int** | Max number of records to return.
   172  
   173  ### Return type
   174  
   175  [**[]ApiV2010SipAuthCallsCredentialListMapping**](ApiV2010SipAuthCallsCredentialListMapping.md)
   176  
   177  ### Authorization
   178  
   179  [accountSid_authToken](../README.md#accountSid_authToken)
   180  
   181  ### HTTP request headers
   182  
   183  - **Content-Type**: Not defined
   184  - **Accept**: application/json
   185  
   186  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   187  [[Back to Model list]](../README.md#documentation-for-models)
   188  [[Back to README]](../README.md)
   189