Répertorier les ressources d’un locataire.¶

Méthode¶

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

Description¶

Répertorie les ressources rattachées au locataire. Utilisez les paramètres de requête limit et page_token pour parcourir toutes les ressources page par page.

Paramètres de chemin¶

tenant_id string obligatoire

Identifiant du locataire.

Paramètres de requête¶

limit int32

Nombre maximal d’éléments à renvoyer par page.

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/tenants/{tenant_id}/resources

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

object

ResourcePage contient les ressources renvoyées 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 ressources.

object

Resource décrit une ressource gérée.

id string

Identifiant unique de la ressource.

external_id string

Identifiant externe de la ressource (Google Workspace, Microsoft 365, etc.).

tenant_id string

Identifiant du locataire auquel la ressource est rattachée.

name string

Nom de la ressource (par exemple, l’adresse e-mail d’un utilisateur pour un locataire Google Workspace ou Microsoft 365, ou le nom d’un Drive partagé).

kind string

Type de ressource (par exemple, office_user ou office_teamdrive).

archived boolean

Indique si la ressource est archivée. Lorsque la valeur est true, Afi ne synchronise plus de nouvelles données depuis la ressource (par exemple, si elle a été supprimée du système source).

Exemple de réponse¶

{
  "next_page_token": "string",
  "items": [
    {
      "id": "string",
      "external_id": "string",
      "tenant_id": "string",
      "name": "string",
      "kind": "string",
      "archived": true
    }
  ]
}