Anwendungsinstallationen auflisten.¶

Methode¶

GET https://papi.afi.ai/api/v1/applications/me/installations

Beschreibung¶

Listet die Installationen für die durch den Authentifizierungsschlüssel identifizierte Anwendung auf. Mit den Abfrageparametern limit und page_token können Sie alle Installationen seitenweise durchlaufen.

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/applications/me/installations

Schema der erfolgreichen Antwort (200)¶

object

InstallationPage enthält die Ergebnisse der Auflistung von Anwendungsinstallationen.

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 Installationen.

object

Installation beschreibt die Eigenschaften einer Anwendungsinstallation. Anwendungen können für bestimmte Mandanten oder organisationsweit installiert werden. Bei organisationsweiten Installationen ist `tenant_id` leer. Verwenden Sie die API zum Auflisten untergeordneter Organisationen, um die Mandanten in der mit der Installation verknüpften Organisation aufzuführen.

tenant_id string

Mandant, in dem die Anwendung installiert ist. Bei organisationsweiten Installationen leer.

org_id string

Organisation, in der die Anwendung installiert ist. Bei Installationen auf Mandantenebene leer.

Antwortbeispiel¶

{
  "next_page_token": "string",
  "items": [
    {
      "tenant_id": "string",
      "org_id": "string"
    }
  ]
}