Lister mes suggestions d'organisation

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

Liste les organisations que l'utilisateur authentifié est invité à rejoindre en raison du domaine de l'une de ses adresses e-mail vérifiées. Une organisation est suggérée lorsqu'elle est active, a vérifié ce domaine avec la capture de domaine réglée sur suggest, et que l'utilisateur n'y a aucune adhésion (une adhésion supprimée ou quittée compte aussi, afin de ne jamais être suggérée à nouveau). Un élément est renvoyé par organisation, par ordre de slug, à concurrence de 20. Une organisation que l'utilisateur a ignorée trois fois n'est pas listée. Si le rôle de membre par défaut de l'environnement ne peut pas être accordé par capture de domaine (un rôle d'administrateur, un rôle privilégié, ou un rôle disposant d'autorisations système au-delà de la lecture de l'organisation et de ses membres), la liste est vide. La lecture ne modifie rien et ne nécessite pas de session récemment vérifiée. Nécessite le cookie __Host-idp_session de l'utilisateur authentifié ; si le cookie est absent, expiré ou révoqué, renvoie 401 unauthenticated. Une application de première partie sur une autre origine peut à la place envoyer son jeton d'accès à l'API front (Authorization: DPoP <token> avec une preuve DPoP ; voir Jeton d'accès à l'API front).

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

Requête

En-têtes :

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

Aucun paramètre de requête. Aucun corps.

Réponse

200 OK avec {"data": [...]}. La réponse n'est pas mise en cache (Cache-Control: no-store).

Chaque élément : id (odm_…, l'enregistrement de domaine vérifié ; à utiliser pour rejoindre ou ignorer), domain (le domaine e-mail correspondant) et organization avec id (org_…), slug et name (nom d'affichage dont les caractères de contrôle et bidirectionnels ont été retirés ; le slug lorsque l'organisation n'a pas de nom ; à afficher comme texte brut).

Erreurs

Statut Code Quand
401 unauthenticated Aucun cookie de session ni jeton d'accès à l'API front valide.
503 temporarily_unavailable L'annuaire des adhésions n'a pas répondu ; réessayez plus tard.

Exemple

curl https://example.keenauth.app/fapi/v1/me/organization-suggestions \
  -H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
  -b cookies.txt
{
  "data": [
    {
      "id": "odm_01j9a5c4000000000000000001",
      "domain": "acme.example",
      "organization": {
        "id": "org_01j9xxxxxxxxxxxxxxxxxxxxxx",
        "slug": "acme",
        "name": "Acme"
      }
    }
  ]
}

Données personnelles

Cet point d'accès traite des données personnelles : adhésions et invitations aux organisations. 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.