Obtenir une ressource.¶

Méthode¶

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

Description¶

Obtient une ressource à partir de son identifiant ou de son identifiant externe.

Paramètres de chemin¶

tenant_id string obligatoire

Identifiant du locataire auquel la ressource est rattachée.

id string obligatoire

Identifiant de la ressource demandée. Un identifiant externe peut être utilisé s’il est précédé de ext$.

curl

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

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

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¶

{
  "id": "string",
  "external_id": "string",
  "tenant_id": "string",
  "name": "string",
  "kind": "string",
  "archived": true
}