Disable a Single Security Identity

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 (i.e., 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:

Request template

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>

Payload (see Security Identity Models - BaseIdentityBody)

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

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:

In the Authorization HTTP header:

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

Disabling a single user security identity in a security identity provider

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 **********-****-****-****-************

Payload

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

Successful response - 202 Accepted

null
What's Next for Me?