Approvals (Beta)

Delete an approval key

Delete (revoke) an approval public key for the specified API user. The deletion may require approval: it always does for the API user's last key or another user's key. In that case the response carries ccrIdPendingDeletion, the key reads as APPROVAL_API_KEY_STATUS_PENDING_DELETION and stays active until the request is approved. A rejected request leaves the key enabled.

Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin.

delete/management/api_users/{userId}/approval_keys/{keyId}

Request

Path parameters

userIdstring required

The ID of the API user whose approval key to delete.

keyIdstring required

The ID of the approval key to delete.

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Response

The approval key was deleted, or its deletion is pending approval.

ccrIdPendingDeletionstring required

Always returned. An empty string when the key was deleted immediately. Otherwise, the ID of the approval request that must be approved before the key is removed; the key stays active until then. The request appears in GET /v1/approvals.

Example response

{
  "ccrIdPendingDeletion": "19332"
}

Changes

No recorded changes to this operation across all 1 revision of this API.