Creare una credenziale dell'applicazione
POST /v1/applications/{application_id}/credentials · permesso applications:write · Idempotency-Key opzionale
Aggiunge una credenziale a un'applicazione: un segreto client generato dalla piattaforma (type: client_secret) o una chiave pubblica registrata per private_key_jwt (type: public_key).
- Segreto client. La risposta contiene
client_secretuna sola volta. Non può essere recuperato di nuovo; salvalo immediatamente. Un'applicazione contiene al massimo 2 segreti attivi, quindi un segreto può essere ruotato senza tempi di inattività. - Chiave pubblica. Invia il JWK pubblico in
jwk. Un JWK con membri privati (d,p,q,dp,dq,qi,oth,k) o di dimensioni superiori a 16 KiB viene rifiutato. Un'applicazione contiene al massimo 5 chiavi. - Ripetizione idempotente. Ripetere la richiesta con la stessa
Idempotency-Keyripete la risposta memorizzata senza il segreto: il corpo hasecret_redacted: truee nessunclient_secret. Crea una nuova credenziale se il segreto è stato perso.
Richiesta
| Parametro | In | Descrizione |
|---|---|---|
application_id |
yol | Application id (app_…). |
Body:
| Campo | Tipo | Descrizione |
|---|---|---|
type |
string | Required. client_secret or public_key. |
expires_at |
string (date-time) | Optional, client_secret only; must be in the future. |
jwk |
object | Required for public_key; a public JWK, at most 16 KiB. |
Risposta
201 Created with Cache-Control: no-store. The credential object as in the list response; for client_secret it also has client_secret.
{
"id": "cred_0000000000000000000000001z",
"type": "client_secret",
"secret_last4": "abcd",
"client_secret": "<shown once>",
"expires_at": null
}
Errori
| HTTP | code |
Quando |
|---|---|---|
| 401 | unauthenticated |
The key is missing, invalid or revoked. |
| 403 | insufficient_permissions |
The key lacks the required permission. |
| 404 | not_found |
The application does not exist in this environment. |
| 409 | credential_limit_reached |
The application already has the maximum number of active secrets (2) or keys (5). |
| 409 | conflict |
The same public key is already registered for the application. |
| 422 | validation_failed |
The body is invalid: unknown type, missing jwk, private JWK members, JWK too large, expires_at in the past or sent with public_key, or a credential type the application type does not allow (/type: not_allowed: client_secret only for web and m2m; public_key for web, m2m, device and management; spa and native are public clients and take no credentials). |
| 503 | service_unavailable |
The credential registry is temporarily unavailable; retry after the Retry-After delay. |
Esempio
curl -X POST https://api.eu.keenauth.com/v1/applications/app_6f8d0cjgbmf0gtn2rg6pscp3cg/credentials \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"type":"client_secret"}'