Disable old security identities
Disable old security identities
You can perform a single Delete old security identities
request to disable a set of security identities in a specific security identity provider.
This request disables identities that were last updated by a Push API request with an orderingId
value lower than the value you specify.
|
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
DELETE https://api.cloud.coveo.com/push/v1/organizations/<MyOrganizationId>/providers/<MySecurityIdentityProviderId>/permissions/olderthan?orderingId=<MyOrderingId> HTTP/1.1
Accept: application/json
Authorization: Bearer <MyAccessToken>
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 ID of the target security identity provider. See Create a security identity provider for a secured Push source for details.
In the query string:
-
Replace
<MyOrderingId>
with theorderingId
value you want to use to indicate that any security identity pushed with a request whoseorderingId
is lower (older) than this value should be disabled in the security identity cache. See About the orderingId parameter 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:
{}
Successful response: 202 Accepted
{}
Sample request
The following example shows how to disable all security identities older than the specified orderingId
value.
DELETE https://api.cloud.coveo.com/push/v1/organizations/mycoveocloudv2organizationg8tp8wu3/providers/My%20Secured%20Push%20Source%20Security%20Identity%20Provider/permissions/olderthan?orderingId=1509711177594 HTTP/1.1
Accept: application/json
Authorization: Bearer **********-****-****-****-************
Request body:
{}