github.com/grokify/go-ringcentral-client@v0.3.31/engagedigital/v1/client/docs/IdentitiesApi.md (about)

     1  # \IdentitiesApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetAllIdentities**](IdentitiesApi.md#GetAllIdentities) | **Get** /identities | Getting all identities
     8  [**GetIdentity**](IdentitiesApi.md#GetIdentity) | **Get** /identities/{identityId} | Getting an identity from its id
     9  
    10  
    11  
    12  ## GetAllIdentities
    13  
    14  > GetAllIdentitiesResponse GetAllIdentities(ctx, optional)
    15  Getting all identities
    16  
    17  This method renders identities ordered by creation date (descending). Only identities in sources where token’s user has “read” permission are returned.
    18  
    19  ### Required Parameters
    20  
    21  
    22  Name | Type | Description  | Notes
    23  ------------- | ------------- | ------------- | -------------
    24  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    25   **optional** | ***GetAllIdentitiesOpts** | optional parameters | nil if no parameters
    26  
    27  ### Optional Parameters
    28  
    29  Optional parameters are passed through a pointer to a GetAllIdentitiesOpts struct
    30  
    31  
    32  Name | Type | Description  | Notes
    33  ------------- | ------------- | ------------- | -------------
    34   **communityId** | **optional.String**| To filter identities on given community id. | 
    35   **identityGroupId** | **optional.String**| To filter on given group id. | 
    36   **userId** | **optional.String**| To filter identities on given user id. | 
    37   **sort** | **optional.String**| To change the criteria chosen to sort the identities. The value can be “created_at” or | 
    38   **foreignId** | **optional.String**| To filter identities on given user id | 
    39   **uuid** | **optional.String**| To filter identities on given uuid | 
    40   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
    41   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
    42  
    43  ### Return type
    44  
    45  [**GetAllIdentitiesResponse**](GetAllIdentitiesResponse.md)
    46  
    47  ### Authorization
    48  
    49  No authorization required
    50  
    51  ### HTTP request headers
    52  
    53  - **Content-Type**: Not defined
    54  - **Accept**: application/json
    55  
    56  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    57  [[Back to Model list]](../README.md#documentation-for-models)
    58  [[Back to README]](../README.md)
    59  
    60  
    61  ## GetIdentity
    62  
    63  > Identity GetIdentity(ctx, identityId)
    64  Getting an identity from its id
    65  
    66  This method renders an identity from given id. If token’s user does not have “read” on identity’s source community a 404 HTTP response will be returned.
    67  
    68  ### Required Parameters
    69  
    70  
    71  Name | Type | Description  | Notes
    72  ------------- | ------------- | ------------- | -------------
    73  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    74  **identityId** | **string**|  | 
    75  
    76  ### Return type
    77  
    78  [**Identity**](Identity.md)
    79  
    80  ### Authorization
    81  
    82  No authorization required
    83  
    84  ### HTTP request headers
    85  
    86  - **Content-Type**: Not defined
    87  - **Accept**: application/json
    88  
    89  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    90  [[Back to Model list]](../README.md#documentation-for-models)
    91  [[Back to README]](../README.md)
    92