veil

Leggi i dati della persona

Gli stessi dati del token ID, dallo stato della scheda adesso: una chiave revocata, un subentro o una sospensione cambiano subito la risposta.

GET/oidc/userinfo
Accesso
Serve un codice privato
Client
Client locale o server

Esempi di richiesta#

cURL
curl -fsS -H "Authorization: Bearer $ACCESS_TOKEN" 'https://veil.rip/oidc/userinfo'

Risposta#

HTTP 200application/json

I dati degli scope del token.

CampoTipoSignificato
substringIl numero della scheda, per tutta la sua vita.
name, picture, preferred_username, profilestringprofile: il nome della scheda, l'URL dell'immagine, l'alias o u<n>, https://veil.rip/u/<n>.
veil_version, veil_log, veil_good_standing, veil_standing_reasonsmixedveil: la versione corrente, {origin, index, size, root}, lo stato ora e perché no (suspended, closing, takeover, name_hidden, key_revoked, key_banned).
veil_accountsarray<object>veil:accounts: [{platform, id, handle, url, verified_at}].
veil_orgsarray<object>veil:orgs: [{n, name, role}].
veil_keysobjectveil:keys: {devices: [{key, alg}], external: [{type, fp}]}.

Intestazioni della risposta#

IntestazioneValoreSignificato
Content-Typeapplication/jsonJSON, anche per gli errori.
Cache-Controlno-storePrivata: 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.
  • Il token di accesso va in Authorization: Bearer. Un 401 porta WWW-Authenticate con l'errore.
  • Qui non si legge nessuna chiave API: un'intestazione Authorization su /oidc/ è la credenziale dell'app o della persona.

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

HTTPCodiceSignificato e cosa fare
401invalid_request

Errore OAuth: manca il token di accesso in Authorization: Bearer.

Manda il token di accesso nell'intestazione, mai nell'indirizzo.

401invalid_token

Errore OAuth: il token di accesso non è valido, è scaduto o revocato, oppure la scheda è stata chiusa.

Rinnovalo, o fai accedere di nuovo la persona.

401veil_suspended

La scheda è sospesa dallo staff di Veil: userinfo non risponde per lei.

Tratta la persona come uscita finché dura la sospensione. La scheda dice perché.

Errori comuni delle richieste
HTTPCodiceSignificato e cosa fare
429rate_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.

500internal_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.

503busy

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.