Docs

Révoquer une clé d’API ; elle cesse de fonctionner aussitôt

  • Dans le bac à sable

En termes simples

Révoque aussitôt une clé d’API.
POST
/keys/{id}/revoke

Autorisation

apiKey
headerAuthorizationBearer <token>

Envoyez votre clé sous forme de jeton bearer : Authorization: Bearer <your-api-key>. L’état du service est le seul appel qui ne nécessite pas de clé.

Paramètres de chemin

id*string

Corps de la réponse

Révoquée (ou déjà révoquée).

application/json
  1. response
id*string
client*string
environment*string
Valeur parmi"sandbox""production"
scopes*array<>
label?string
created_at*string
Formatdate-time
revoked_at?string
Formatdate-time
also_revoked?array<string>

Uniquement dans une réponse de révocation : les identifiants des clés créées sous celle-ci qui ont été révoquées avec elle.

curl -X POST "https://example.com/keys/string/revoke" \  -H "Authorization: Bearer <your-api-key>"
{  "id": "string",  "client": "string",  "environment": "sandbox",  "scopes": [    "submit"  ],  "label": "string",  "created_at": "2019-08-24T14:15:22Z",  "revoked_at": "2019-08-24T14:15:22Z",  "also_revoked": [    "string"  ]}