github.com/twilio/twilio-go@v1.20.1/rest/verify/v2/docs/ServicesEntitiesApi.md (about)

     1  # ServicesEntitiesApi
     2  
     3  All URIs are relative to *https://verify.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateEntity**](ServicesEntitiesApi.md#CreateEntity) | **Post** /v2/Services/{ServiceSid}/Entities | 
     8  [**DeleteEntity**](ServicesEntitiesApi.md#DeleteEntity) | **Delete** /v2/Services/{ServiceSid}/Entities/{Identity} | 
     9  [**FetchEntity**](ServicesEntitiesApi.md#FetchEntity) | **Get** /v2/Services/{ServiceSid}/Entities/{Identity} | 
    10  [**ListEntity**](ServicesEntitiesApi.md#ListEntity) | **Get** /v2/Services/{ServiceSid}/Entities | 
    11  
    12  
    13  
    14  ## CreateEntity
    15  
    16  > VerifyV2Entity CreateEntity(ctx, ServiceSidoptional)
    17  
    18  
    19  
    20  Create a new Entity for the Service
    21  
    22  ### Path Parameters
    23  
    24  
    25  Name | Type | Description
    26  ------------- | ------------- | -------------
    27  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    28  **ServiceSid** | **string** | The unique SID identifier of the Service.
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a CreateEntityParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  **Identity** | **string** | The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
    38  
    39  ### Return type
    40  
    41  [**VerifyV2Entity**](VerifyV2Entity.md)
    42  
    43  ### Authorization
    44  
    45  [accountSid_authToken](../README.md#accountSid_authToken)
    46  
    47  ### HTTP request headers
    48  
    49  - **Content-Type**: application/x-www-form-urlencoded
    50  - **Accept**: application/json
    51  
    52  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    53  [[Back to Model list]](../README.md#documentation-for-models)
    54  [[Back to README]](../README.md)
    55  
    56  
    57  ## DeleteEntity
    58  
    59  > DeleteEntity(ctx, ServiceSidIdentity)
    60  
    61  
    62  
    63  Delete a specific Entity.
    64  
    65  ### Path Parameters
    66  
    67  
    68  Name | Type | Description
    69  ------------- | ------------- | -------------
    70  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    71  **ServiceSid** | **string** | The unique SID identifier of the Service.
    72  **Identity** | **string** | The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
    73  
    74  ### Other Parameters
    75  
    76  Other parameters are passed through a pointer to a DeleteEntityParams struct
    77  
    78  
    79  Name | Type | Description
    80  ------------- | ------------- | -------------
    81  
    82  ### Return type
    83  
    84   (empty response body)
    85  
    86  ### Authorization
    87  
    88  [accountSid_authToken](../README.md#accountSid_authToken)
    89  
    90  ### HTTP request headers
    91  
    92  - **Content-Type**: Not defined
    93  - **Accept**: Not defined
    94  
    95  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    96  [[Back to Model list]](../README.md#documentation-for-models)
    97  [[Back to README]](../README.md)
    98  
    99  
   100  ## FetchEntity
   101  
   102  > VerifyV2Entity FetchEntity(ctx, ServiceSidIdentity)
   103  
   104  
   105  
   106  Fetch a specific Entity.
   107  
   108  ### Path Parameters
   109  
   110  
   111  Name | Type | Description
   112  ------------- | ------------- | -------------
   113  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   114  **ServiceSid** | **string** | The unique SID identifier of the Service.
   115  **Identity** | **string** | The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
   116  
   117  ### Other Parameters
   118  
   119  Other parameters are passed through a pointer to a FetchEntityParams struct
   120  
   121  
   122  Name | Type | Description
   123  ------------- | ------------- | -------------
   124  
   125  ### Return type
   126  
   127  [**VerifyV2Entity**](VerifyV2Entity.md)
   128  
   129  ### Authorization
   130  
   131  [accountSid_authToken](../README.md#accountSid_authToken)
   132  
   133  ### HTTP request headers
   134  
   135  - **Content-Type**: Not defined
   136  - **Accept**: application/json
   137  
   138  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   139  [[Back to Model list]](../README.md#documentation-for-models)
   140  [[Back to README]](../README.md)
   141  
   142  
   143  ## ListEntity
   144  
   145  > []VerifyV2Entity ListEntity(ctx, ServiceSidoptional)
   146  
   147  
   148  
   149  Retrieve a list of all Entities for a Service.
   150  
   151  ### Path Parameters
   152  
   153  
   154  Name | Type | Description
   155  ------------- | ------------- | -------------
   156  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   157  **ServiceSid** | **string** | The unique SID identifier of the Service.
   158  
   159  ### Other Parameters
   160  
   161  Other parameters are passed through a pointer to a ListEntityParams struct
   162  
   163  
   164  Name | Type | Description
   165  ------------- | ------------- | -------------
   166  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   167  **Limit** | **int** | Max number of records to return.
   168  
   169  ### Return type
   170  
   171  [**[]VerifyV2Entity**](VerifyV2Entity.md)
   172  
   173  ### Authorization
   174  
   175  [accountSid_authToken](../README.md#accountSid_authToken)
   176  
   177  ### HTTP request headers
   178  
   179  - **Content-Type**: Not defined
   180  - **Accept**: application/json
   181  
   182  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   183  [[Back to Model list]](../README.md#documentation-for-models)
   184  [[Back to README]](../README.md)
   185