Répertorier les locataires d’une organisation.¶

Méthode¶

GET https://papi.afi.ai/api/v1/orgs/{org_id}/tenants

Description¶

Répertorie les locataires correspondant à l’identifiant d’organisation indiqué. Utilisez les paramètres de requête limit et page_token pour parcourir les locataires page par page.

Paramètres de chemin¶

org_id string obligatoire

Identifiant de l’organisation dont les locataires doivent être répertoriés.

Paramètres de requête¶

limit int32

Nombre maximal d’éléments à renvoyer par page (100 par défaut).

page_token string

Jeton de l’opération de liste précédente (`next_page_token`) utilisé pour poursuivre l’énumération.

curl

curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/orgs/{org_id}/tenants

Schéma de la réponse réussie (200)¶

object

TenantsPage contient les résultats de l’énumération des locataires de l’organisation.

next_page_token string

Jeton de la page suivante dans l’opération d’énumération. Définissez cette valeur comme `page_token` dans la requête suivante. Vide sur la dernière page.

items array of objects

Liste des locataires.

object

Tenant décrit un locataire unique.

id string

Identifiant unique du locataire.

external_id string

Identifiant externe (Google Workspace, Microsoft 365, etc.) du locataire.

kind string

Type de locataire (`gsuite` pour Google Workspace, `o365` pour Microsoft 365, etc.).

name string

Nom du locataire. Pour les locataires Google Workspace et Microsoft 365, il s’agit généralement du nom de domaine.

region string

Région où se trouve le locataire. Code de pays ou de territoire à deux lettres conforme à la norme ISO 3166-1 alpha-2 (par exemple, US, CA, AU, UK, EU, DE, CH).

deleted boolean

True si le locataire a été résilié et ne peut plus être interrogé. Les abonnements des locataires supprimés utilisent l’état `canceled`.

Exemple de réponse¶

{
  "next_page_token": "string",
  "items": [
    {
      "id": "string",
      "external_id": "string",
      "kind": "string",
      "name": "string",
      "region": "string",
      "deleted": true
    }
  ]
}