Get Users

Cortex Xpanse REST API

post /public_api/v1/rbac/get_users/

Required license: **Cortex Xpanse Expander**

Retrieve a list of the current users in your environment.

CURL
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/"
Request headers
authorization
required
String
api-key
Example: {{api_key}}
x-xdr-auth-id
required
String
api-key-id
Example: {{api_key_id}}
Responses

OK

Body
reply
required
Array of objects
JSON object containing the query result.
user_email
required
String
Email address of the user.
user_first_name
required
String
First name of the user.
user_last_name
required
String
Last name of the user.
role_name
optional
String
Role name associated with the user.
last_logged_in
optional
Integer
Timestamp of when the user last logged in.
user_type
required
String
Type of user.
groups
required
Array of strings
Name of user groups associated with the user, if applicable.
scope
optional
Array of objects
Name of scope associated with the user, if applicable.
tag_id
required
String
tag_name_with_alias
required
String

Bad Request. Got an invalid JSON.

Body
reply
required
The query results upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.

Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.

Body
reply
required
The query results upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.

Unauthorized access. User does not have the required license type to run this API.

Body
reply
required
The query results upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.

Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.

Body
reply
required
The query results upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.

Unprocessable Entity

Body
code
optional
Integer
Error code
status
optional
String
Error name
message
optional
String
Error message
errors
optional
Object
Errors

Internal server error. A unified status for API communication type errors.

Body
reply
required
The query results upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.