Ressourcen eines Mandanten auflisten.¶

Methode¶

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

Beschreibung¶

Ruft Ressourcen ab, die dem Mandanten gehören. Mit den Abfrageparametern limit und page_token können Sie alle Ressourcen seitenweise durchlaufen.

Pfadparameter¶

tenant_id string erforderlich

ID des Mandanten, dessen Ressourcen aufgelistet werden sollen.

Abfrageparameter¶

limit int32

Maximale Anzahl der pro Seite zurückzugebenden Elemente.

page_token string

Token aus dem vorherigen Listenaufruf (`next_page_token`), mit dem die Auflistung fortgesetzt wird.

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 der Auflistung. Legen Sie diesen Wert in der nachfolgenden Anfrage als `page_token` fest. Auf der letzten Seite ist er leer.

items array of objects

Liste der Ressourcen.

object

Resource beschreibt eine einzelne verwaltete Ressource.

id string

Eindeutige ID der Ressource.

external_id string

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

tenant_id string

Mandant, dem die Ressource gehört.

name string

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

kind string

Ressourcenart (beispielsweise office_user oder office_teamdrive).

archived boolean

Gibt an, ob die Ressource archiviert ist. Bei true kann die Ressource nicht mehr gesichert werden (beispielsweise wenn sie gelöscht wurde).

Antwortbeispiel¶

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