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

     1  # CustomerProfilesEntityAssignmentsApi
     2  
     3  All URIs are relative to *https://trusthub.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateCustomerProfileEntityAssignment**](CustomerProfilesEntityAssignmentsApi.md#CreateCustomerProfileEntityAssignment) | **Post** /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments | 
     8  [**DeleteCustomerProfileEntityAssignment**](CustomerProfilesEntityAssignmentsApi.md#DeleteCustomerProfileEntityAssignment) | **Delete** /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid} | 
     9  [**FetchCustomerProfileEntityAssignment**](CustomerProfilesEntityAssignmentsApi.md#FetchCustomerProfileEntityAssignment) | **Get** /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid} | 
    10  [**ListCustomerProfileEntityAssignment**](CustomerProfilesEntityAssignmentsApi.md#ListCustomerProfileEntityAssignment) | **Get** /v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments | 
    11  
    12  
    13  
    14  ## CreateCustomerProfileEntityAssignment
    15  
    16  > TrusthubV1CustomerProfileEntityAssignment CreateCustomerProfileEntityAssignment(ctx, CustomerProfileSidoptional)
    17  
    18  
    19  
    20  Create a new Assigned Item.
    21  
    22  ### Path Parameters
    23  
    24  
    25  Name | Type | Description
    26  ------------- | ------------- | -------------
    27  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    28  **CustomerProfileSid** | **string** | The unique string that we created to identify the CustomerProfile resource.
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a CreateCustomerProfileEntityAssignmentParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  **ObjectSid** | **string** | The SID of an object bag that holds information of the different items.
    38  
    39  ### Return type
    40  
    41  [**TrusthubV1CustomerProfileEntityAssignment**](TrusthubV1CustomerProfileEntityAssignment.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  ## DeleteCustomerProfileEntityAssignment
    58  
    59  > DeleteCustomerProfileEntityAssignment(ctx, CustomerProfileSidSid)
    60  
    61  
    62  
    63  Remove an Assignment Item Instance.
    64  
    65  ### Path Parameters
    66  
    67  
    68  Name | Type | Description
    69  ------------- | ------------- | -------------
    70  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    71  **CustomerProfileSid** | **string** | The unique string that we created to identify the CustomerProfile resource.
    72  **Sid** | **string** | The unique string that we created to identify the Identity resource.
    73  
    74  ### Other Parameters
    75  
    76  Other parameters are passed through a pointer to a DeleteCustomerProfileEntityAssignmentParams 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  ## FetchCustomerProfileEntityAssignment
   101  
   102  > TrusthubV1CustomerProfileEntityAssignment FetchCustomerProfileEntityAssignment(ctx, CustomerProfileSidSid)
   103  
   104  
   105  
   106  Fetch specific Assigned Item Instance.
   107  
   108  ### Path Parameters
   109  
   110  
   111  Name | Type | Description
   112  ------------- | ------------- | -------------
   113  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   114  **CustomerProfileSid** | **string** | The unique string that we created to identify the CustomerProfile resource.
   115  **Sid** | **string** | The unique string that we created to identify the Identity resource.
   116  
   117  ### Other Parameters
   118  
   119  Other parameters are passed through a pointer to a FetchCustomerProfileEntityAssignmentParams struct
   120  
   121  
   122  Name | Type | Description
   123  ------------- | ------------- | -------------
   124  
   125  ### Return type
   126  
   127  [**TrusthubV1CustomerProfileEntityAssignment**](TrusthubV1CustomerProfileEntityAssignment.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  ## ListCustomerProfileEntityAssignment
   144  
   145  > []TrusthubV1CustomerProfileEntityAssignment ListCustomerProfileEntityAssignment(ctx, CustomerProfileSidoptional)
   146  
   147  
   148  
   149  Retrieve a list of all Assigned Items for an account.
   150  
   151  ### Path Parameters
   152  
   153  
   154  Name | Type | Description
   155  ------------- | ------------- | -------------
   156  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   157  **CustomerProfileSid** | **string** | The unique string that we created to identify the CustomerProfile resource.
   158  
   159  ### Other Parameters
   160  
   161  Other parameters are passed through a pointer to a ListCustomerProfileEntityAssignmentParams struct
   162  
   163  
   164  Name | Type | Description
   165  ------------- | ------------- | -------------
   166  **ObjectType** | **string** | A string to filter the results by (EndUserType or SupportingDocumentType) machine-name. This is useful when you want to retrieve the entity-assignment of a specific end-user or supporting document.
   167  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   168  **Limit** | **int** | Max number of records to return.
   169  
   170  ### Return type
   171  
   172  [**[]TrusthubV1CustomerProfileEntityAssignment**](TrusthubV1CustomerProfileEntityAssignment.md)
   173  
   174  ### Authorization
   175  
   176  [accountSid_authToken](../README.md#accountSid_authToken)
   177  
   178  ### HTTP request headers
   179  
   180  - **Content-Type**: Not defined
   181  - **Accept**: application/json
   182  
   183  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   184  [[Back to Model list]](../README.md#documentation-for-models)
   185  [[Back to README]](../README.md)
   186