Disable a single security identity

This is for:

In this article

Request template
Sample request

Being able to disable a single security identity in the security identity provider of a secured Push source can especially useful when you’re testing the service or when you need to perform a very small security identity update.

Use the Delete a security identity operation to disable a specific security identity in a certain security identity provider.

You should never use this operation repetitively to disable many security identities in a security identity provider (that is, to perform a large scale security identity update). When this is what you need to do, depending on what you want to achieve, you should either use:

The batch operation (see Manage batches of security identities in a security identity provider).
The delete older than operation (see Disable old security identities).

Request template

Request definition

DELETE https://api.cloud.coveo.com/push/v1/organizations/<MyOrganizationId>/providers/<MySecurityIdentityProviderId>/permissions HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: Bearer <MyAccessToken>

Request body

See Security identity models - BaseIdentityBody.

{
  "identity": {
    "name": <MySecurityIdentityName>,
    "type": <"GROUP"|"UNKNOWN"|"USER"|"VIRTUAL_GROUP">
  }
}

Note

For legacy reasons, the request path of this operation includes the word permissions instead of identities. While those two concepts are related, they have entirely different meanings.

Remember that this operation actually allows you to interact with security identities (not item permissions).

In the request path:

Replace <MyOrganizationId> with the actual ID of the target Coveo organization (see Retrieve the organization ID).
Replace <MySecurityIdentityProviderId> with the actual ID of the target security identity provider (see Create a security identity provider for a secured Push source).

In the Authorization HTTP header:

Replace <MyAccessToken> with an access token that grants the Organization - View and Security identity providers - View/Edit privileges in the target Coveo organization (see Create an API key, Get the privileges of an access token, and Get your Coveo access token).

In the request body (see Security identity models - BaseIdentityBody):

Replace <MySecurityIdentityName> with the name of the security identity to disable.
Replace <"GROUP"|"UNKNOWN"|"USER"|"VIRTUAL_GROUP"> with the entity type of the security identity to delete.

Sample request

The following example shows how to disable a single user security identity in a security identity provider.

Request definition

DELETE https://api.cloud.coveo.com/push/v1/organizations/mycoveocloudv2organizationg8tp8wu3/providers/My%20Secured%20Push%20Source%20Security%20Identity%20Provider/permissions HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: Bearer **********-****-****-****-************

Request body

{
  "identity": {
    "name": "asmith@example.com",
    "type": "USER"
  }
}

Successful response - 202 Accepted

null