AdminUsersGetResponse GetAdminUsers(ctx, optional)
This provides a list of users in the system
Required Parameters
| Name | Type | Description | Notes |
|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetAdminUsersOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a GetAdminUsersOpts struct
| Name | Type | Description | Notes |
|---|
| xCorrelationId | optional.String | Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request | |
| offset | optional.Int32 | the number of users to skip before getting the result set | |
| limit | optional.Int32 | the number of users to return. | [default to 100] |
| orderBy | optional.String | the field to sort | [default to created_date_time] |
| direction | optional.String | the sort order | [default to DESC] |
| status | optional.String | the value should be in [active, trial, inactive, deleted] | |
| name | optional.String | Name of user | |
| userName | optional.String | userName of user | |
| email | optional.String | email of user | |
| roleIDs | optional.Interface of string | Filters by role | |
| organizationIDs | optional.Interface of string | Filters by internal organization ID | |
| accessAllOrganization | optional.Bool | A user can access to all organization or not. | |
| isSuperAdmin | optional.Bool | | |
Return type
AdminUsersGetResponse
Authorization
api_key
- Content-Type: Not defined
- Accept: application/json
