Zum Inhalt

Mandanten einer Organisation auflisten.

Methode

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

Beschreibung

Listet die Mandanten der Organisation mit der angegebenen ID auf. Mit den Abfrageparametern limit und page_token rufen Sie die Mandanten seitenweise ab.

Pfadparameter
org_id string erforderlich

ID der Organisation, deren Mandanten aufgelistet werden.

Abfrageparameter
limit int32

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

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

 
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 Auflistung von Mandanten einer Organisation.
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 Mandanten.

object

Tenant beschreibt einen Afi-Mandanten.
id string

Eindeutige ID des Mandanten.
external_id string

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

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

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

Afi-Region, in der der Mandant gehostet wird. Zweistelliger Regionscode auf Basis von ISO 3166-1 alpha-2, einschließlich der ausnahmsweise reservierten Codes UK und EU (beispielsweise US, CA, AU, UK, EU, DE, CH).
deleted boolean

Gibt an, ob der Mandant endgültig deaktiviert wurde und nicht mehr abgefragt werden kann. Abonnements gelöschter Mandanten haben den Status canceled.

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