Table of Contents

Api Tenants et applications multi organisations

Certaines applications offrent des services à des utilisateurs qui peuvent être inscrits dans plusieurs organisations. Ces applications peuvent accéder à la liste des organisations qui lui ont accordé un consentement et dont l’utilisateur est membre. Vous pouvez en savoir plus sur l’expérience du consentement de l’application.

Obtention du jeton d’accès

Pour appeler l’api, il faut obtenir un jeton d’accès valide pour la portée Tenant.Read. La procédure est similaire à toute obtention de jeton d’accès. Pour plus d’informations sur cette procédure, voyez la section correspondante pour les pages des applications natives ou des applications web. Notez que pour accéder ensuite à TenantsApi, la requête à authorize doit indiquer Tenant.Read dans le champ scope. Les applications machine/robot n’ont pas accès à la TenantsApi et recevront une réponse de type Unauthorized.

Utilisation du jeton d’accès

L’api Tenants retournera une liste des identifiants (ids et noms). Pour appeler l’api, il faut faire une requête GET similaire à d’autres demandes d’accès à des ressources et ressemble à celle-ci:

GET /{tenant_id}/api/tenants HTTP/1.1
Host: https://mozaikacces.ca
Authorization: Bearer NzUzODkyYzAtNGExOC00NGI0LWE5MzAtMjkyYWU3MzlkM2I5
Paramètre Condition Description
Autorization Obligatoire Le jeton d’accès et son type. Le seul type pris en charge par la plateforme d’identité Mozaïk est Bearer. L’absence du jeton d’accès dans la requête entraînera une réponse de type Unauthorized.

Réponse réussie

Une réponse réussie contient une liste de paires tenantId et nom que l’application cliente pourra utiliser pour contacter les organismes correspondants. Elle ressemble à ceci:

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache
Pragma: no-cache

[
   {
      "id": "79714fd9-ede8-4c2d-9247-073d1bd2fd9b",
      "nom": "Organisation A"
   },
   {
      "id": "413d4fd4-5ce8-48b0-a864-8ff7aa728d7a",
      "nom": "Organisation B"
   }
]

Aide supplémentaire

Représentation graphique de la séquence des appels au service d'authentification Séquence des appels