Delete one or more users on the Cohesity Cluster.

delete

https://cluster.ip.address/irisservices/api/v1/public/users

Privileges: PRINCIPAL_MODIFY

Only users from the same domain can be deleted by a single request.
If the Cohesity user was created for an Active Directory user, the referenced
principal user on the Active Directory domain is NOT deleted.
Only the user on the Cohesity Cluster is deleted.
Returns Success if the specified users are deleted.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to delete one or more users on the Cohesity Cluster.

Specifies the users to delete on the Cohesity Cluster.

domain

string | null

Specifies the domain associated with the users to delete.
Only users associated with the same domain can be deleted by a
single request.
If no domain is specified, the specified users are deleted from the
LOCAL domain on the Cohesity Cluster.
If a non-LOCAL domain is specified, the specified users are deleted
on the Cohesity Cluster. However, the referenced user principals on the
Active Directory are not deleted.

tenantId

string | null

Specifies the tenant for which the users are to be deleted.

users

array of strings | null

Array of Users.

Specifies the list of users to delete on Cohesity Cluster.
Only users from the same domain can be deleted by a single request.

users

Responses

204

No Content

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

defaultError