Ispeziona un token

RFC 7662, per le app confidenziali: se uno dei token dell'app è attivo adesso.

POST/oidc/introspect

Accesso: Serve un codice privato
Client: Client locale o server

Corpo JSON#

Nome	Posizione	Significato
`token`Obbligatorio	JSON	Il token.

Esempi di richiesta#

cURL

curl -fsS -u "$CLIENT_ID:$CLIENT_SECRET" \
  -d token="$ACCESS_TOKEN" "https://veil.rip/oidc/introspect"

Risposta#

HTTP 200application/json

{active, …}; {active: false} per ogni token non attivo o non dell'app.

Campo	Tipo	Significato
`active`	`boolean`	Non revocato, non ruotato, non scaduto, la scheda aperta e non sospesa.
`scope, client_id, sub, aud, iss, iat, exp, token_type, auth_time`	`mixed`	Come li nomina RFC 7662, quando attivo.
`veil_good_standing`	`boolean`	Lo stato della scheda adesso, quando attivo.

Intestazioni della risposta#

Intestazione	Valore	Significato
`Content-Type`	`application/json`	JSON, anche per gli errori.
`Cache-Control`	`no-store`	Privata: mai in una cache.

Note d’uso#

Gli errori di questo endpoint seguono OAuth: {"error", "error_description"} (RFC 6749, 5.2), non l'oggetto error del resto delle API. Un limite risponde comunque 429 con la busta solita.

Errori#

Gli errori API restituiscono un oggetto error. Usa error.code nella logica del programma; error.message è un testo inglese per le persone e può cambiare. Guida a risposte ed errori

HTTP Codice Significato e cosa fare

400

HTTP	Codice	Significato e cosa fare
400	`invalid_request`	Errore OAuth: un parametro manca, è ripetuto o malformato, oppure il corpo non è un modulo. Leggi `error_description`, correggi la richiesta e mandala di nuovo.
401	`invalid_client`	Errore OAuth: l'app non si è autenticata con il metodo che ha registrato. Controlla client id e segreto (Basic), l'asserzione (private_key_jwt, un jti nuovo ogni volta) o client_id per un'app pubblica.

invalid_request

Errore OAuth: un parametro manca, è ripetuto o malformato, oppure il corpo non è un modulo.

Leggi error_description, correggi la richiesta e mandala di nuovo.

401

invalid_client

Errore OAuth: l'app non si è autenticata con il metodo che ha registrato.

Controlla client id e segreto (Basic), l'asserzione (private_key_jwt, un jti nuovo ogni volta) o client_id per un'app pubblica.

Errori comuni delle richieste

HTTP Codice Significato e cosa fare

429

HTTP	Codice	Significato e cosa fare
429	`rate_limited`	È stato superato un limite anonimo, delle richieste firmate o della chiave API. Attendi almeno i secondi indicati da `Retry-After`. Condividi coda e budget dei tentativi tra i tuoi processi.
500	`internal_error`	Si è verificato un errore imprevisto del server. I dettagli interni non vengono restituiti. Riprova le letture con attese crescenti e un limite. Controlla l’esito delle scritture prima di inviare una nuova operazione firmata.
503	`busy`	L’applicazione ha raggiunto un limite temporaneo di concorrenza o del database. Attendi i secondi indicati da `Retry-After` e riprova con attese crescenti e un limite.

rate_limited

È stato superato un limite anonimo, delle richieste firmate o della chiave API.

Attendi almeno i secondi indicati da Retry-After. Condividi coda e budget dei tentativi tra i tuoi processi.

500

internal_error

Si è verificato un errore imprevisto del server. I dettagli interni non vengono restituiti.

Riprova le letture con attese crescenti e un limite. Controlla l’esito delle scritture prima di inviare una nuova operazione firmata.

503

busy

L’applicazione ha raggiunto un limite temporaneo di concorrenza o del database.

Attendi i secondi indicati da Retry-After e riprova con attese crescenti e un limite.

Leggi questa voce in JSON