SAsahha
Credentials

Revoke a secret

Stops the secret authenticating. A client secret stops minting account tokens immediately; an app secret stops registering profiles within five minutes. Tokens already issued are unaffected. The reason is required and recorded. Any member of the account can restore the secret within 24 hours.

post/api/v1/account/credentials/secrets/{secretId}/revoke

Request

  • Base URL
    https://api.sahha.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

Path parameters

secretIdstring uuid required

Query parameters

environmentstring

Request body

accountIdstring uuid

The account the credential belongs to.

environmentstring

sandbox or production. It must be the environment the request is sent to.

credentialTypestring

application or client.

reasonstring

Why the secret is being revoked. Recorded against it.

Example request

{
  "environment": "sandbox",
  "credentialType": "client",
  "reason": "Leaked in a CI log."
}

Response

Every secret of the credential after the revoke.

Changes

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