Elencare i permessi

GET /v1/permissions · permesso apis:read

Restituisce i permessi (scope OAuth) di un'API, dal più recente, in pagine a cursore, insieme ai testi mostrati nella schermata di consenso. L'ambiente proviene solo dalla credenziale.

Richiesta

Parametro Tipo Obbligatorio Descrizione
api_id stringa sì L'API (api_…). Se manca, è ripetuto o malformato, la risposta è 422 con puntatore /api_id.
limit intero no Da 1 a 100, predefinito 20.
after stringa no Cursore da list_metadata.after. Si esclude con before.
before stringa no Cursore da list_metadata.before.
order stringa no asc o desc (predefinito). Un cursore è valido solo con lo stesso api_id e order.

Risposta

200 OK

{
  "data": [ {
  "id": "perm_01h455vb4pex5vsknk084sn02s",
  "api_id": "api_01h455vb4pex5vsknk084sn02q",
  "value": "read:orders",
  "display_name": "Read orders",
  "description": "See your past orders and their status",
  "consent_text_i18n": {
    "en": "Read your orders",
    "tr": "Siparişlerinizi okuyun"
  },
  "sensitivity": "normal"
} ],
  "list_metadata": { "before": null, "after": "eyJ2IjoxLi4ufQ" }
}

Un permesso senza testi di consenso ha display_name e description impostati a null e consent_text_i18n impostato a {}. Un cursore null significa che non ci sono altri record in quella direzione. Non viene restituito alcun conteggio totale.

Errori

HTTP code Quando
400 invalid_cursor Il cursore è malformato, manomesso, oppure è stato emesso per un altro ambiente, un altro api_id o un altro order.
403 insufficient_permissions La credenziale non ha apis:read.
404 not_found Non esiste tale API in questo ambiente.
422 validation_failed api_id manca, è ripetuto o malformato, oppure un altro parametro di query non è valido.

Esempio

curl "https://api.eu.keenauth.com/v1/permissions?api_id=api_01h455vb4pex5vsknk084sn02q&limit=20" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"