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

     1  # \UsersApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateUser**](UsersApi.md#CreateUser) | **Post** /users | Creating a user
     8  [**DeleteUser**](UsersApi.md#DeleteUser) | **Delete** /users/{userId} | Deleting a user
     9  [**GetAllUsers**](UsersApi.md#GetAllUsers) | **Get** /users | Getting all users
    10  [**GetUser**](UsersApi.md#GetUser) | **Get** /users/{userId} | Getting a user from its id
    11  [**InviteUser**](UsersApi.md#InviteUser) | **Post** /users/invite | Inviting a user
    12  [**UpdateUser**](UsersApi.md#UpdateUser) | **Put** /users/{userId} | Updating a user
    13  
    14  
    15  
    16  ## CreateUser
    17  
    18  > User CreateUser(ctx, email, firstname, lastname, password, roleId, optional)
    19  Creating a user
    20  
    21  This method creates a new user. In case of success it renders the created user, otherwise, it renders an error (422 HTTP code).
    22  
    23  ### Required Parameters
    24  
    25  
    26  Name | Type | Description  | Notes
    27  ------------- | ------------- | ------------- | -------------
    28  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    29  **email** | **string**| User email (mandatory). | 
    30  **firstname** | **string**| User firstname (mandatory). | 
    31  **lastname** | **string**| User lastname (mandatory). | 
    32  **password** | **string**| User plain password (mandatory). | 
    33  **roleId** | **string**| User role id (mandatory). | 
    34   **optional** | ***CreateUserOpts** | optional parameters | nil if no parameters
    35  
    36  ### Optional Parameters
    37  
    38  Optional parameters are passed through a pointer to a CreateUserOpts struct
    39  
    40  
    41  Name | Type | Description  | Notes
    42  ------------- | ------------- | ------------- | -------------
    43  
    44  
    45  
    46  
    47  
    48   **categoryIds** | [**optional.Interface of []string**](string.md)| User list of category ids (multiple). | 
    49   **enabled** | **optional.Bool**| Whether the user is enabled or not (boolean). | 
    50   **externalId** | **optional.String**| User external id, used for SSO. | 
    51   **gender** | **optional.String**| User gender (\"man\" or \"woman\"). | 
    52   **identityIds** | [**optional.Interface of []string**](string.md)| User list of identity ids (multiple). | 
    53   **locale** | **optional.String**| Language for the user interface. | 
    54   **nickname** | **optional.String**| User nickname. | 
    55   **teamIds** | [**optional.Interface of []string**](string.md)| User list of team ids (multiple). | 
    56   **timezone** | **optional.String**| Use the timezone endpoint to get the timezone name (String), default is empty for domain timezone. | 
    57   **spokenLanguages** | [**optional.Interface of []string**](string.md)| List of locales corresponding to the languages spoken by the user (multiple). | 
    58  
    59  ### Return type
    60  
    61  [**User**](User.md)
    62  
    63  ### Authorization
    64  
    65  No authorization required
    66  
    67  ### HTTP request headers
    68  
    69  - **Content-Type**: Not defined
    70  - **Accept**: application/json
    71  
    72  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    73  [[Back to Model list]](../README.md#documentation-for-models)
    74  [[Back to README]](../README.md)
    75  
    76  
    77  ## DeleteUser
    78  
    79  > User DeleteUser(ctx, userId)
    80  Deleting a user
    81  
    82  This method deletes the given user. In case of success it renders the deleted user, otherwise, it renders an error (422 HTTP code).  Authorization​: only users that can update users. The user affiliated to the token must have at least all the permissions of the other user. If the user affiliated to the token has the manage_users_of_my_teams permission, the deleted user will need to belong to at least one of the teams he’s the leader of.
    83  
    84  ### Required Parameters
    85  
    86  
    87  Name | Type | Description  | Notes
    88  ------------- | ------------- | ------------- | -------------
    89  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    90  **userId** | **string**|  | 
    91  
    92  ### Return type
    93  
    94  [**User**](User.md)
    95  
    96  ### Authorization
    97  
    98  No authorization required
    99  
   100  ### HTTP request headers
   101  
   102  - **Content-Type**: Not defined
   103  - **Accept**: application/json
   104  
   105  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   106  [[Back to Model list]](../README.md#documentation-for-models)
   107  [[Back to README]](../README.md)
   108  
   109  
   110  ## GetAllUsers
   111  
   112  > GetAllUsersResponse GetAllUsers(ctx, optional)
   113  Getting all users
   114  
   115  This method renders users ordered by creation date (descending).  Authorization​: only users that can view users. If the user affiliated to the token has the manage_users_of_my_teams permission, only the users belonging to at least one of the teams he’s the leader of will be returned.
   116  
   117  ### Required Parameters
   118  
   119  
   120  Name | Type | Description  | Notes
   121  ------------- | ------------- | ------------- | -------------
   122  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   123   **optional** | ***GetAllUsersOpts** | optional parameters | nil if no parameters
   124  
   125  ### Optional Parameters
   126  
   127  Optional parameters are passed through a pointer to a GetAllUsersOpts struct
   128  
   129  
   130  Name | Type | Description  | Notes
   131  ------------- | ------------- | ------------- | -------------
   132   **email** | **optional.String**| To filter users on given email. | 
   133   **categoryId** | **optional.String**| To filter users on given category id. | 
   134   **identityId** | **optional.String**| To filter users on given identity id. | 
   135   **externalId** | **optional.String**| To filter users on given external id. | 
   136   **roleId** | **optional.String**| To filter users on given role id. | 
   137   **teamId** | **optional.String**| To filter users on given team id. | 
   138   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
   139   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
   140  
   141  ### Return type
   142  
   143  [**GetAllUsersResponse**](GetAllUsersResponse.md)
   144  
   145  ### Authorization
   146  
   147  No authorization required
   148  
   149  ### HTTP request headers
   150  
   151  - **Content-Type**: Not defined
   152  - **Accept**: application/json
   153  
   154  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   155  [[Back to Model list]](../README.md#documentation-for-models)
   156  [[Back to README]](../README.md)
   157  
   158  
   159  ## GetUser
   160  
   161  > User GetUser(ctx, userId)
   162  Getting a user from its id
   163  
   164  This method renders a user from given id.
   165  
   166  ### Required Parameters
   167  
   168  
   169  Name | Type | Description  | Notes
   170  ------------- | ------------- | ------------- | -------------
   171  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   172  **userId** | **string**|  | 
   173  
   174  ### Return type
   175  
   176  [**User**](User.md)
   177  
   178  ### Authorization
   179  
   180  No authorization required
   181  
   182  ### HTTP request headers
   183  
   184  - **Content-Type**: Not defined
   185  - **Accept**: application/json
   186  
   187  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   188  [[Back to Model list]](../README.md#documentation-for-models)
   189  [[Back to README]](../README.md)
   190  
   191  
   192  ## InviteUser
   193  
   194  > User InviteUser(ctx, email, firstname, lastname, roleId, optional)
   195  Inviting a user
   196  
   197  This method invites a new user. In case of success it renders the created user, otherwise, it renders an error (422 HTTP code).  Authorization​: only users that can invite other users. If the user affiliated to the token has the manage_users_of_my_teams permission, the invited user will need to belong to at least one of the teams he’s the leader of. It will not be possible to assign the user to other teams.
   198  
   199  ### Required Parameters
   200  
   201  
   202  Name | Type | Description  | Notes
   203  ------------- | ------------- | ------------- | -------------
   204  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   205  **email** | **string**| User email (mandatory). | 
   206  **firstname** | **string**| User firstname (mandatory). | 
   207  **lastname** | **string**| User lastname (mandatory). | 
   208  **roleId** | **string**| User role id (mandatory). | 
   209   **optional** | ***InviteUserOpts** | optional parameters | nil if no parameters
   210  
   211  ### Optional Parameters
   212  
   213  Optional parameters are passed through a pointer to a InviteUserOpts struct
   214  
   215  
   216  Name | Type | Description  | Notes
   217  ------------- | ------------- | ------------- | -------------
   218  
   219  
   220  
   221  
   222   **categoryIds** | [**optional.Interface of []string**](string.md)| User list of category ids (multiple). | 
   223   **enabled** | **optional.Bool**| Whether the user is enabled or not (boolean). | 
   224   **externalId** | **optional.String**| User external id. | 
   225   **gender** | **optional.String**| User gender (\"man\" or \"woman\"). | 
   226   **identityIds** | [**optional.Interface of []string**](string.md)| User list of identity ids (multiple). | 
   227   **locale** | **optional.String**| Language for the user interface. | 
   228   **nickname** | **optional.String**| User nickname. | 
   229   **teamIds** | [**optional.Interface of []string**](string.md)| User list of team ids (multiple). | 
   230   **timezone** | **optional.String**| Use the timezone endpoint to get the timezone name (String), default is empty for | 
   231   **spokenLanguages** | [**optional.Interface of []string**](string.md)| List of locales corresponding to the languages spoken by the user (multiple). | 
   232  
   233  ### Return type
   234  
   235  [**User**](User.md)
   236  
   237  ### Authorization
   238  
   239  No authorization required
   240  
   241  ### HTTP request headers
   242  
   243  - **Content-Type**: Not defined
   244  - **Accept**: application/json
   245  
   246  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   247  [[Back to Model list]](../README.md#documentation-for-models)
   248  [[Back to README]](../README.md)
   249  
   250  
   251  ## UpdateUser
   252  
   253  > User UpdateUser(ctx, userId, optional)
   254  Updating a user
   255  
   256  This method updates users from given attributes and renders it in case of success.  Authorization​: only users that can update users. If the user affiliated to the token has the `manage_users_of_my_teams` permission, the updated user will need to belong to at least one of the teams he’s the leader of. The teams the user affiliated to the token is the leader of will be the only ones which can be added or removed.
   257  
   258  ### Required Parameters
   259  
   260  
   261  Name | Type | Description  | Notes
   262  ------------- | ------------- | ------------- | -------------
   263  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   264  **userId** | **string**|  | 
   265   **optional** | ***UpdateUserOpts** | optional parameters | nil if no parameters
   266  
   267  ### Optional Parameters
   268  
   269  Optional parameters are passed through a pointer to a UpdateUserOpts struct
   270  
   271  
   272  Name | Type | Description  | Notes
   273  ------------- | ------------- | ------------- | -------------
   274  
   275   **categoryIds** | [**optional.Interface of []string**](string.md)| User list of category ids (multiple). | 
   276   **email** | **optional.String**| User email. | 
   277   **enabled** | **optional.Bool**| Whether the user is enabled or not (boolean). | 
   278   **externalId** | **optional.String**| User external id, used for SSO. | 
   279   **firstname** | **optional.String**| User firstname. | 
   280   **gender** | **optional.String**| User gender (\"man\" or \"woman\"). | 
   281   **identityIds** | [**optional.Interface of []string**](string.md)| User list of identity ids (multiple). | 
   282   **lastname** | **optional.String**| User lastname. | 
   283   **locale** | **optional.String**| Language for the user interface. | 
   284   **nickname** | **optional.String**| User nickname. | 
   285   **password** | **optional.String**| User plain password. | 
   286   **roleId** | **optional.String**| User role id. | 
   287   **teamIds** | [**optional.Interface of []string**](string.md)| User list of team ids (multiple). | 
   288   **timezone** | **optional.String**| Use the timezone endpoint to get the timezone name (String), default is empty for domain timezone. | 
   289   **spokenLanguages** | [**optional.Interface of []string**](string.md)| List of locales corresponding to the languages spoken by the user (multiple). | 
   290  
   291  ### Return type
   292  
   293  [**User**](User.md)
   294  
   295  ### Authorization
   296  
   297  No authorization required
   298  
   299  ### HTTP request headers
   300  
   301  - **Content-Type**: Not defined
   302  - **Accept**: application/json
   303  
   304  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   305  [[Back to Model list]](../README.md#documentation-for-models)
   306  [[Back to README]](../README.md)
   307