post
/public_api/v1/rbac/get_user_group
Retrieve a list of the current user emails associated with one or more user groups in your environment.
Required license: Cortex XDR Pro per Endpoint, Cortex XDR Pro, or Cortex XDR Pro per GB
CURL
curl -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://api-yourfqdn/public_api/v1/rbac/get_user_group" \
-d '{
"request_data" : {
"group_names" : [ "group_names", "group_names" ]
}
}'
Request
Body
optional
Example:
{"request_data":{"group_names":["Group1","Group2"]}}
request_data
required
A dictionary containing the API request fields.
group_names
optional
Array
of strings
List of one or more user group names for which you want the associated users.
Responses
OK
Body
reply
optional
Array
JSON object containing the query result.
group_name
optional
String
Name of the User Group.
description
optional
Object
Description of the User Group, if available.
pretty_name
optional
String
Name of the User Group as it appears in the Management Console.
insert_time
optional
Integer
Timestamp of when the User Group was created.
update_time
optional
Integer
Timestamp of when the User Group was last updated.
user_email
optional
Array
of strings
List of email addresses belonging to the users associated with the User Group.
source
optional
String
Type of User Group.
Bad Request. Got an invalid JSON.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
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
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
err_extra
optional
String
Additional information describing the error.
Unauthorized access. User does not have the required license type to run this API.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
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
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
err_extra
optional
String
Additional information describing the error.
Internal server error. A unified status for API communication type errors.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
err_extra
optional
String
Additional information describing the error.