Skip to main content

Delete User Set Policy

This API deletes an existing user set policy identified by its unique ID. Once deleted, the policy can no longer be used or applied.

Endpoint Details

URL/v1/config-agent/user-sets/id
MethodDELETE
AuthorizationBearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Path

To delete a specific user set policy, use the following request format:

/v1/config-agent/user-sets/564ba2ee-9edb-4801-b4e5-9f26df28b197

Path Parameter

ParameterTypeDescription
idUUIDUnique identifier of the user set policy to delete

Response

Here is an example response after the request has been successfully processed:

Response
{
"success": true
}

Field Descriptions

FieldTypeDescription
successBooleanIndicates whether the user set policy was successfully deleted

info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing user set policy.
  • Deleting a user set policy is permanent and cannot be undone.