Lister mes organisations

GET /fapi/v1/me/organizations · appelé depuis l'hôte de connexion de l'environnement

Liste les organisations vers lesquelles l'utilisateur authentifié peut basculer dans une application : les organisations dans lesquelles l'utilisateur a une appartenance active, qui sont actives et pour lesquelles l'application est activée, triées par slug, au maximum 100. C'est la liste qu'affiche un sélecteur d'organisation, et la même liste que propose le sélecteur d'organisation hébergé lors de la connexion ; elle n'affiche donc jamais une organisation que l'application ne peut pas utiliser. Aucun élément n'est marqué comme courant : l'organisation à laquelle le jeton de votre application est lié est indiquée par la revendication org_id du jeton. La lecture ne modifie rien et ne nécessite pas une session vérifiée récemment. Nécessite le cookie __Host-idp_session de l'utilisateur authentifié ; si le cookie est absent, expiré ou révoqué, renvoie 401 unauthenticated.

Avec @keenauth/js : await keenauth.organizations.listMine().

Requête

En-têtes :

En-tête Obligatoire Description
Idp-Client oui Identifiant du SDK.

Paramètres de requête :

Paramètre Obligatoire Description
client_id oui Le client_id de l'application de première partie dans laquelle s'exécute le sélecteur.

Pas de corps.

Réponse

200 OK avec {"data": [...], "truncated": false}.

Chaque élément : id (org_…, sous la même forme que la revendication org_id du jeton et que le paramètre organization), slug, name (nom d'affichage dont les caractères de contrôle et bidirectionnels ont été supprimés ; le slug lorsque l'organisation n'a pas de nom ; à afficher comme texte brut). truncated vaut true lorsque l'utilisateur possède davantage de ces organisations que celles listées.

Erreurs

Statut Code Quand
401 unauthenticated Aucun cookie de session valide.
403 headless_not_allowed L'application est une application tierce.
422 validation_failed client_id est absent, vide, dépasse 255 caractères, est fourni plusieurs fois ou est inconnu (/client_id).
503 temporarily_unavailable L'annuaire des appartenances n'a pas répondu ; réessayez plus tard.

Exemple

curl "https://example.keenauth.app/fapi/v1/me/organizations?client_id=app_01j9zzzzzzzzzzzzzzzzzzzz" \
  -H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
  -b cookies.txt
{
  "data": [
    {
      "id": "org_01j9xxxxxxxxxxxxxxxxxxxxxx",
      "slug": "acme",
      "name": "Acme"
    }
  ],
  "truncated": false
}

Données personnelles

Cet point de terminaison traite des données personnelles : appartenances aux organisations et invitations. Données personnelles dans les API KeenAuth décrit ce qui est stocké, la durée de conservation et la manière dont elles sont supprimées. N'envoyez pas de catégories particulières de données personnelles (santé, données biométriques, religion, opinions politiques, orientation sexuelle) dans aucun champ.