This returns the list of users in the Equotix One account.
Request
Body Params application/json
The domain you are assigned to authenticate your Equotix One account.
The email address assigned to the user account in your Equotix One.
The unix timestamp used to sign this API request.
The calculated signature for this API request.
The user ID to search for specifically.
filter_user_group_id
integerÂ
optionalFilter the list of users by the user group ID.
Filter the list of users by the username.
filter_date_modified
stringÂ
optionalFilter the list of users modified after the spcified date.
Filter the list of users to include deleted records.
Page number of the results.
The key for the ordering of the results. Accepts "username", "name", "user_group", "date_added", "date_modified", "date_active".
The direction for the ordering of the results. Accepts "ASC", "DESC"
The number of results per page. Accepts 1 to 100.
{
"domain": "string",
"api_key": "string",
"auth_timestamp": 0,
"auth_signature": "string",
"user_id": 0,
"filter_user_group_id": 0,
"filter_username": "string",
"filter_date_modified": "string",
"filter_deleted": true,
"page": 0,
"sort": "string",
"order": "string",
"limit": 0
}
Responses
application/json Returns only if there is an error.
users
array [object {11}]Â
optionalThe date time user was created.
The date time user was last modified.
The date time user was last active.
Indicates if the user has been deleted. Only returned if filter_deleted is "1".
{
"error": [
"string"
],
"users": [
{
"user_id": 0,
"user_group_id": 0,
"username": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"preference": {},
"date_added": "string",
"date_modified": "string",
"date_active": "string",
"deleted": true
}
]
}
Modified at 2024-10-20 12:47:25