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 de l’organisation indiquée par son identifiant. 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.

Paramètres de requête¶

limit int32

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

page_token string

Jeton renvoyé par l’appel précédent (next_page_token), à utiliser pour obtenir la suite des résultats.

curl

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

Schéma de la réponse en cas de succès (200)¶

object

TenantsPage contient les locataires de l’organisation renvoyés sur cette page.

next_page_token string

Jeton permettant d’obtenir la page suivante. Transmettez cette valeur dans le paramètre page_token de la requête suivante. Le jeton est vide sur la dernière page.

items array of objects

Liste des locataires.

object

Tenant décrit un locataire.

id string

Identifiant unique du locataire.

external_id string

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

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 dans laquelle le locataire est hébergé. Code de région à deux lettres fondé sur la norme ISO 3166-1 alpha-2, y compris les codes exceptionnellement réservés UK et EU (par exemple, US, CA, AU, UK, EU, DE ou CH).

deleted boolean

Indique si le locataire a été définitivement désactivé et ne peut plus être interrogé. Les abonnements d’un locataire supprimé ont pour état canceled.

Exemple de réponse¶

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