+ Nouvelle clé

Aide du Hub TheSocle · apim.tenantdetail.cles.nouvelle

Émet une clé pour ce tenant. Le scope proposé, api:*, ouvre toutes les API : le remplacer par celui de l'API visée.

Voir l'élément dans l'écran : hub/apim/tenants-detail

Explication

Le Hub demande un nom (« default » proposé), puis les scopes séparés par des virgules. Il affiche ensuite la clé en clair, une seule fois : copiez-la avant de fermer le message, puis transmettez-la au client par un canal sûr.

Exemple de scopes pour un client qui lit NotionSocle : api:notionsocle:read.

Fiche complète

Requête

POST /api/apim/admin/keys

Paramètre	Envoyé par l'écran	Remarque
`id_tenant`	ce tenant	obligatoire
`key_name`	saisi	`default` par défaut
`scopes`	saisis	liste
`tier`	`free`
`env`	`prod`	préfixe de la clé générée
`allowed_ips`	—	liste d'IP autorisées (pas à l'écran)
`expires_at`	—	date ISO-8601 (pas à l'écran) : sans elle, la clé n'expire pas

Réponse

{ "status": "created", "x_id": 25, "raw_key": "sk-DEMO0000…",
  "key_hash": "deadbeef…", "warning": "Save this raw_key — it will NEVER be shown again." }

Pièges

Le scope proposé api:* ouvre toutes les API du Hub au client.
La clé est rattachée au premier compte trouvé dans le tenant ; si le tenant n'a aucun compte, au compte numéro 1 du Hub. C'est ce numéro que reçoit l'application dans X-APIM-User-Id.
La clé est montrée dans une fenêtre d'alerte du navigateur : rien ne permet de la retrouver ensuite.

Sommaire du démonstrateur