Aller au contenu

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 appartenant 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 dont les ressources doivent être répertoriées.

Paramètres de requête
limit int32

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

page_token string

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

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

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

ResourcePage contient les résultats de l’énumération des ressources.

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 ressources.

object

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

id string

Identifiant unique de la ressource.

external_id string

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

tenant_id string

Locataire propriétaire de la ressource.

name string

Nom de la ressource (par exemple, l’adresse e-mail d’un utilisateur pour les locataires 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, la ressource ne peut plus être sauvegardée (par exemple, si elle a été supprimée).

Exemple de réponse
{
  "next_page_token": "string",
  "items": [
    {
      "id": "string",
      "external_id": "string",
      "tenant_id": "string",
      "name": "string",
      "kind": "string",
      "archived": true
    }
  ]
}