Zum Inhalt

Einen Mandanten abrufen.

Methode

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

Beschreibung

Ruft einen Mandanten anhand seiner ID ab.

Pfadparameter
id string erforderlich

ID des abzurufenden Mandanten.

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

Schema der erfolgreichen Antwort (200)
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
{
  "id": "string",
  "external_id": "string",
  "kind": "string",
  "name": "string",
  "region": "string",
  "deleted": true
}