Obtenir un locataire.¶

Méthode¶

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

Description¶

Obtient un locataire à partir de son identifiant.

Paramètres de chemin¶

id string obligatoire

Identifiant du locataire à obtenir.

curl

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

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

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¶

{
  "id": "string",
  "external_id": "string",
  "kind": "string",
  "name": "string",
  "region": "string",
  "deleted": true
}