Deactivate credential

Edit online

Deactivates a credential that is currently active. If the credential is already inactive, no action is taken.

HTTP request
PUT /auth/credentials/deactivate
Authorization requirements
Header Type Required Description
Authorization string Yes Bearer token used to authenticate the request. See Authentication flows for instructions on generating this token.
X-DFNS-USERACTION string Yes User action signature used to authorize change-inducing requests. See User Action Signing flows for instructions on generating this signature.
Request body
Field Type Required Description
credentialUuid string Yes The UUID of the credential to deactivate. Minimum length: 1. 
curl --request PUT \
  --url https://api.digitalassets.ibm.com/auth/credentials/deactivate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DFNS-USERACTION: <api-key>' \
  --data '
{
  "credentialUuid": "<string>"
}
'
Response
200: Success

Example response:

{
  "message": "<string>"
}