Leggi appartenenze e inviti

Leggi le appartenenze di una persona o i membri di un’organizzazione.

GET/v1/identities/{n}/orgs

Accesso: Pubblico; chiave API facoltativa
Client: Fetch dal browser supportato

Parametri#

Nome	Posizione	Significato
`n`Obbligatorio	Percorso	Numero permanente positivo della scheda.

Esempi di richiesta#

cURL

curl -fsS 'https://veil.rip/v1/identities/1/orgs'

javascript

const response = await fetch("https://veil.rip/v1/identities/1/orgs");
const result = await response.json();

Prova la richiesta#

Risposta#

HTTP 200application/json

n, type e memberships. Include ruolo, stato di accettazione e di rimozione.

Campo	Tipo	Significato
`n`	`integer`	Numero della scheda richiesta.
`type`	`string`	person o organization.
`memberships`	`array<Membership>`	Affiliazioni correnti e precedenti, inclusi gli inviti.

Apri un oggetto annidato per leggerne i campi. I tipi con null ammettono un valore null; i campi optional possono essere assenti. Gli altri campi sono presenti nell’oggetto.

Affiliazione o invito Membership

Campo	Tipo	Significato
`invite`	`integer`	ID dell’affiliazione o invito.
`org`	`OrgRef \| null`	Organizzazione quando si leggono le affiliazioni di una persona.
`member`	`OrgRef \| null`	Persona quando si leggono i membri di un’organizzazione.
`role`	`string`	Ruolo del membro.
`state`	`string`	Stato dell’affiliazione, per esempio pending, active o removed.
`invitedIn`	`integer`	Versione che ha emesso l’invito.
`acceptedIn`	`integer \| null`	Versione che ha accettato l’invito.
`since`	`string \| null`	Data e ora di accettazione.
`removedAt`	`string \| null`	Data e ora di rimozione.
`removedBy`	`string \| null`	Chiave responsabile della rimozione.

Riferimento a un’organizzazione o membro OrgRef

Campo	Tipo	Significato
`n`	`integer`	Numero permanente della scheda.
`url`	`string`	URL permanente della scheda.
`name`	`string`	Nome visualizzato corrente.
`token`	`string`	Pseudonimo stabile nel registro pubblico in base64url.
`nameHidden`	`boolean`	Indica se lo staff nasconde il nome.
`logo`	`object \| null`	Tipo e URL dell’immagine.

Intestazioni della risposta#

Intestazione	Valore	Significato
`Content-Type`	`application/json`	Usa il tipo dichiarato per scegliere come leggere il corpo.
`Date`	`HTTP date`	Ora del server. Confrontala con il tuo orologio per firmare le richieste.
`Retry-After`	`integer seconds, on rate_limited or busy`	Attendi almeno questo intervallo prima di riprovare. Altri codici 429/503 non lo includono necessariamente.

Cosa verificare#

Un invito non è un’appartenenza accettata. Controlla i record firmati della persona e dell’organizzazione prima di fidarti di un ruolo.

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_parameter`	Un campo del percorso, della query o del corpo manca, è malformato o fuori intervallo. Correggi il campo indicato in `error.message` prima di inviare di nuovo.
404	`not_found`	La scheda, la chiave, l’alias, il codice o la risorsa richiesti non sono stati trovati. Controlla l’identificatore. Codici e anteprime temporanei potrebbero essere scaduti o già usati.
410	`erased`	La scheda esisteva ed è stata cancellata o rimossa. La risposta contiene anche la ricevuta pubblica di cancellazione. Smetti di usare questa scheda come autorità corrente. Conserva soltanto la ricevuta pubblica se serve.

invalid_parameter

Un campo del percorso, della query o del corpo manca, è malformato o fuori intervallo.

Correggi il campo indicato in error.message prima di inviare di nuovo.

404

not_found

La scheda, la chiave, l’alias, il codice o la risorsa richiesti non sono stati trovati.

Controlla l’identificatore. Codici e anteprime temporanei potrebbero essere scaduti o già usati.

410

erased

La scheda esisteva ed è stata cancellata o rimossa. La risposta contiene anche la ricevuta pubblica di cancellazione.

Smetti di usare questa scheda come autorità corrente. Conserva soltanto la ricevuta pubblica se serve.

Quando usi una chiave API facoltativa

HTTP	Codice	Significato e cosa fare
401	`invalid_api_key`	La credenziale Bearer è malformata, sconosciuta, scaduta o revocata. Usa una chiave attiva. Per l’accesso pubblico anonimo, rimuovi del tutto `Authorization`. Credenziali non valide non attivano automaticamente l’accesso anonimo.
403	`api_key_scope`	La chiave API non ha il permesso read o verify, oppure l’endpoint non accetta chiavi Bearer. Usa il permesso corretto. Le modifiche alle schede e la gestione delle chiavi richiedono una firma del dispositivo.
403	`api_key_suspended`	Questa chiave API è sospesa. Chiedi allo staff di ripristinarla; un’altra chiave non rimuove la sospensione dell’account.
403	`developer_suspended`	L’account API del titolare è sospeso oppure la scheda titolare non è disponibile. Controlla l’account titolare e le restrizioni dello staff. Creare un’altra chiave non aggira la sospensione.

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