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 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
{
  "id": "string",
  "external_id": "string",
  "kind": "string",
  "name": "string",
  "region": "string",
  "deleted": true
}