Retrieve a list of the current users in your environment.
Required license: Cortex Xpanse Expander
authorization
String
required
{{api_key}}
x-xdr-auth-id
String
required
{{api_key_id}}
curl -X 'POST'
-H
'Accept: application/json'
-H
'authorization: {{api_key}}'
-H
'x-xdr-auth-id: {{api_key_id}}'
'https://api-}/public_api/v1/rbac/get_users/'
OK
replyArray
JSON object containing the query result.
user_emailString
Email address of the user.
user_first_nameString
First name of the user.
user_last_nameString
Last name of the user.
role_nameString
Role name associated with the user.
last_logged_inInteger
Timestamp of when the user last logged in.
user_typeString
Type of user.
groupsArray[string]
Name of user groups associated with the user, if applicable.
scopeArray
Name of scope associated with the user, if applicable.
tag_idString
tag_name_with_aliasString
{
"reply": [
{
"user_email": "user_email_example",
"user_first_name": "user_first_name_example",
"user_last_name": "user_last_name_example",
"role_name": "role_name_example",
"last_logged_in": 0,
"user_type": "user_type_example",
"groups": [
"groups_example"
],
"scope": [
{
"tag_id": "tag_id_example",
"tag_name_with_alias": "tag_name_with_alias_example"
}
]
}
]
}Bad Request. Got an invalid JSON.
replyObject
The query results upon error.
{
"reply": {}
}Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
replyObject
The query results upon error.
{
"reply": {}
}Unauthorized access. User does not have the required license type to run this API.
replyObject
The query results upon error.
{
"reply": {}
}Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
replyObject
The query results upon error.
{
"reply": {}
}Unprocessable Entity
codeInteger
Error code
statusString
Error name
messageString
Error message
errorsObject
Errors
{
"code": 0,
"status": "status_example",
"message": "message_example",
"errors": {}
}Internal server error. A unified status for API communication type errors.
replyObject
The query results upon error.
{
"reply": {}
}