Disable a single security identity

This is for:

In this article

Request template
Sample request

Disabling a single security identity in the security identity provider of a secured Push source is especially useful during service testing or when you need to perform a small security identity update.

Use the Delete a security identity request only to disable a specific security identity in a certain security identity provider. To maximize efficiency and comply with API consumption limits, don’t use this request repeatedly to disable many security identities in a security identity provider. If this is what you need to do, depending on what you want to achieve, you should either use:

Batch update requests.
The Delete old security identities request.

Note

For legacy reasons, the path of this request uses the word permissions instead of identities. While those two concepts are related, they have entirely different meanings. Remember that this request actually allows you to interact with security identities, not item permissions.

Request template

US East region

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>

Canada region

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

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

Ireland region

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

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

Australia region

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

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

Request parameters:

Parameters

In the request path:

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

In the Authorization HTTP header:

Replace <MyAccessToken> with a Push source API key that grants the set of privileges required to push security identities to the security identity provider.

Request body:

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

Parameters

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.

Successful response: 202 Accepted

null

Sample request

The following example shows how to disable 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 **********-****-****-****-************

Request body:

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