Zum Inhalt

Mandanten einer Organisation auflisten.

Methode

GET https://papi.afi.ai/api/v1/orgs/{org_id}/tenants

Beschreibung

Listet die Mandanten für die angegebene Organisations-ID auf. Mit den Abfrageparametern limit und page_token können Sie die Mandanten seitenweise durchlaufen.

Pfadparameter
org_id string erforderlich

ID der Organisation, deren Mandanten aufgelistet werden sollen.

Abfrageparameter
limit int32

Maximale Anzahl der pro Seite zurückzugebenden Elemente (Standardwert: 100).
page_token string

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

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

Schema der erfolgreichen Antwort (200)
object

TenantsPage enthält die Ergebnisse der Mandantenauflistung einer Organisation.
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 Mandanten.

object

Tenant beschreibt einen einzelnen Mandanten.
id string

Eindeutige ID des Mandanten.
external_id string

Externe ID des Mandanten (Google Workspace, Microsoft 365 usw.).
kind string

Mandantenart (`gsuite` für Google Workspace, `o365` für Microsoft 365 usw.).
name string

Name des Mandanten. Bei Google Workspace- und Microsoft 365-Mandanten ist dies üblicherweise der Domänenname.
region string

Region, in der sich der Mandant befindet. Zweistelliger Länder- oder Gebietscode gemäß ISO 3166-1 Alpha-2 (beispielsweise US, CA, AU, UK, EU, DE, CH).
deleted boolean

True, wenn der Mandant endgültig deaktiviert (gekündigt) wurde und nicht mehr abgefragt werden kann. Gelöschte Mandantenabonnements verwenden den Status `canceled`.

Antwortbeispiel
{
  "next_page_token": "string",
  "items": [
    {
      "id": "string",
      "external_id": "string",
      "kind": "string",
      "name": "string",
      "region": "string",
      "deleted": true
    }
  ]
}