System Management
APIs for managing system
Retrieve information about one or more roles created in your environment. Required license: Cortex Xpanse Expander
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/rbac/get_roles/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"request_data": {
"role_names": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": [
[
{
"pretty_name": "text",
"permissions": [
"text"
],
"insert_time": 1,
"update_time": 1,
"created_by": "text",
"description": "text",
"groups": [
"text"
],
"users": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}Get your tenant license information. Required license: Cortex Xpanse Expander
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/system/get_tenant_info/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Accept: */*
{
"reply": {
"aum": 1,
"expiration_date": "text",
"activation_date": "text",
"status": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Retrieve a list of the current user emails associated with one or more user groups in your environment. Required license: Cortex Xpanse Expander
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/rbac/get_user_group/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 115
{
"request_data": {
"group_names": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": [
{
"group_name": "text",
"description": "text",
"created_by": "text",
"pretty_name": "text",
"insert_time": 1,
"update_time": 1,
"user_email": [
"text"
],
"source": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}Retrieve a list of the current users in your environment. Required license: Cortex Xpanse Expander
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/rbac/get_users/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Accept: */*
{
"reply": [
{
"user_email": "text",
"user_first_name": "text",
"user_last_name": "text",
"role_name": "text",
"last_logged_in": 1,
"user_type": "text",
"groups": [
"text"
],
"scope": [
{
"tag_id": "text",
"tag_name_with_alias": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}Add or remove one or more users from a role. Required license: Cortex Xpanse Expander
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/rbac/set_user_role/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 134
{
"request_data": {
"user_emails": [
"text"
],
"role_name": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": {
"update_count": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Last updated
Was this helpful?