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 demandé.

curl

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

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

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¶

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