post
/public_api/v1/rbac/get_user_group/
Required license: **Cortex Xpanse Expander**
Retrieve a list of the current user emails associated with one or more user groups in your environment.
CURL
curl -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" -H "authorization: {{api_key}}" -H "x-xdr-auth-id: {{api_key_id}}" \
"https://api-}/public_api/v1/rbac/get_user_group/" \
-d '{
"request_data" : {
"group_names" : [ "group_names", "group_names" ]
}
}'
Request headers
authorization
required
String
api-key
Example:
{{api_key}}
x-xdr-auth-id
required
String
api-key-id
Example:
{{api_key_id}}
Request
Body
required
request_data
required
Object
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
required
Array
of objects
JSON object containing the query result.
group_name
required
String
Name of the User Group.
description
optional
String
Description of the User Group, if available.
created_by
optional
String
pretty_name
optional
String
Name of the User Group as it appears in the Management Console.
insert_time
required
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
required
String
Type of User Group.
Bad Request. Got an invalid JSON.
Body
reply
required
Object
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
Object
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
Object
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
Object
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
Object
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.