post
/public_api/v1/featured_fields/replace_ad_groups
Replace the featured active directory groups and organizational units listed in your environment.
Note: Running this API will delete all existing active directory groups.
Required license: Cortex XDR Pro per Endpoint 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/featured_fields/replace_ad_groups" \
-d '{
"request_data" : {
"fields" : [ {
"comment" : "comment",
"type" : "group",
"value" : "value"
}, {
"comment" : "comment",
"type" : "group",
"value" : "value"
} ]
}
}'
Request
Body
optional
Example:
{"request_data":{"fields":[{"value":"domain/administrators-group","type":"group","comment":"Administrators-group is a featured AD group"},{"value":"dev","type":"OU"}]}}
request_data
required
fields
optional
Array
An array of active directory groups and organizational units and comments.
value
required
String
String value that defines the active directory or organizational unit name. Maximum length is 256 characters.
An active directory name must be formated as: DOMAIN/GROUPNAME
type
optional
String
(Enum)
Define whether you want to replace an active directory group or organizational unit.
Valid values are either
group or OU.
If no value is defined, group is sent by default.
Allowed values:
group
OU
comment
optional
String
String that represents additional information regarding the featured active directory group.
Responses
Successful response
Body
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
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.