Ressourcen eines Mandanten auflisten.¶

Methode¶

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

Beschreibung¶

Listet die dem Mandanten zugeordneten Ressourcen auf. Mit den Abfrageparametern limit und page_token rufen Sie alle Ressourcen seitenweise ab.

Pfadparameter¶

tenant_id string erforderlich

ID des Mandanten, dessen Ressourcen aufgelistet werden.

Abfrageparameter¶

limit int32

Maximale Anzahl der Elemente pro Seite.

page_token string

Token aus der vorherigen Auflistung (next_page_token), mit dem Sie die Auflistung fortsetzen.

curl

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

Schema der erfolgreichen Antwort (200)¶

object

ResourcePage enthält die Ergebnisse der Ressourcenauflistung.

next_page_token string

Token für die nächste Seite. Übergeben Sie diesen Wert in der nächsten Anforderung als page_token. Auf der letzten Seite ist das Token leer.

items array of objects

Liste der Ressourcen.

object

Resource beschreibt eine verwaltete Ressource.

id string

Eindeutige ID der Ressource.

external_id string

Externe ID der Ressource (Google Workspace, Microsoft 365 usw.).

tenant_id string

ID des Mandanten, dem die Ressource zugeordnet ist.

name string

Name der Ressource (beispielsweise die E-Mail-Adresse eines Benutzers in einem Google Workspace- oder Microsoft 365-Mandanten oder der Name einer geteilten Ablage).

kind string

Ressourcentyp (beispielsweise office_user oder office_teamdrive).

archived boolean

Gibt an, ob die Ressource archiviert ist. Bei true können keine neuen Daten aus der Quelle mehr gesichert werden (beispielsweise wenn die zugrunde liegende Ressource im Quellsystem gelöscht wurde).

Antwortbeispiel¶

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