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

     1  # \IdentityGroupsApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetAllIdentityGroups**](IdentityGroupsApi.md#GetAllIdentityGroups) | **Get** /identity_groups | Getting all identity groups
     8  [**GetIdentityGroup**](IdentityGroupsApi.md#GetIdentityGroup) | **Get** /identity_groups/{identityGroupId} | Getting an identity group from its id
     9  [**UpdateIdentityGroup**](IdentityGroupsApi.md#UpdateIdentityGroup) | **Put** /identity_groups/{identityGroupId} | Updating an identity group
    10  
    11  
    12  
    13  ## GetAllIdentityGroups
    14  
    15  > GetAllIdentityGroupsResponse GetAllIdentityGroups(ctx, optional)
    16  Getting all identity groups
    17  
    18  This method renders identity groups ordered by creation date (descending). Note that identity_group are created in a lazily only when data are manually added to an identity OR a two identity are merged altogether. That means that some identity DON’T have identity_group, and identity_group do not cover all identities.  Authorization​: no.
    19  
    20  ### Required Parameters
    21  
    22  
    23  Name | Type | Description  | Notes
    24  ------------- | ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26   **optional** | ***GetAllIdentityGroupsOpts** | optional parameters | nil if no parameters
    27  
    28  ### Optional Parameters
    29  
    30  Optional parameters are passed through a pointer to a GetAllIdentityGroupsOpts struct
    31  
    32  
    33  Name | Type | Description  | Notes
    34  ------------- | ------------- | ------------- | -------------
    35   **firstname** | **optional.String**| To filter groups on given firstname. | 
    36   **lastname** | **optional.String**| To filter groups on given lastname. | 
    37   **email** | **optional.String**| To filter groups that have given email. | 
    38   **uuid** | **optional.String**| To filter groups that have given uuid. | 
    39   **sort** | **optional.String**| To change the criteria chosen to sort the identities. The value can be “created_at” or “updated_at”. | 
    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  [**GetAllIdentityGroupsResponse**](GetAllIdentityGroupsResponse.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  ## GetIdentityGroup
    62  
    63  > IdentityGroup GetIdentityGroup(ctx, identityGroupId)
    64  Getting an identity group from its id
    65  
    66  This method renders an identity group from given id.
    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  **identityGroupId** | **string**|  | 
    75  
    76  ### Return type
    77  
    78  [**IdentityGroup**](IdentityGroup.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  
    93  
    94  ## UpdateIdentityGroup
    95  
    96  > IdentityGroup UpdateIdentityGroup(ctx, identityGroupId, optional)
    97  Updating an identity group
    98  
    99  This method updates an identity group from given attributes and renders it in case of success.  Authorization​: no.
   100  
   101  ### Required Parameters
   102  
   103  
   104  Name | Type | Description  | Notes
   105  ------------- | ------------- | ------------- | -------------
   106  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   107  **identityGroupId** | **string**|  | 
   108   **optional** | ***UpdateIdentityGroupOpts** | optional parameters | nil if no parameters
   109  
   110  ### Optional Parameters
   111  
   112  Optional parameters are passed through a pointer to a UpdateIdentityGroupOpts struct
   113  
   114  
   115  Name | Type | Description  | Notes
   116  ------------- | ------------- | ------------- | -------------
   117  
   118   **company** | **optional.String**| Identity company. | 
   119   **customFieldValuesCustomFieldKey** | **optional.String**| Identity custom field with key « custom_field_key ». It | 
   120   **emails** | [**optional.Interface of []string**](string.md)| Identity emails (multiple). | 
   121   **firstname** | **optional.String**| Identity firstname. | 
   122   **gender** | **optional.String**| Identity’s gender. It can be \"man\", \"woman\" or empty. | 
   123   **homePhones** | [**optional.Interface of []string**](string.md)| Identity home phones (mutiple). | 
   124   **lastname** | **optional.String**| Identity lastname. | 
   125   **mobilePhones** | [**optional.Interface of []string**](string.md)| Identity mobile phones (multiple). | 
   126   **notes** | **optional.String**| Identity notes. | 
   127   **tagIds** | [**optional.Interface of []string**](string.md)| Identity tag ids (multiple). | 
   128  
   129  ### Return type
   130  
   131  [**IdentityGroup**](IdentityGroup.md)
   132  
   133  ### Authorization
   134  
   135  No authorization required
   136  
   137  ### HTTP request headers
   138  
   139  - **Content-Type**: Not defined
   140  - **Accept**: application/json
   141  
   142  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   143  [[Back to Model list]](../README.md#documentation-for-models)
   144  [[Back to README]](../README.md)
   145