Anwendungsinstallationen auflisten.¶

Methode¶

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

Beschreibung¶

Listet die Installationen der Anwendung auf, die durch den API-Schlüssel identifiziert wird. Mit den Abfrageparametern limit und page_token rufen Sie alle Installationen seitenweise ab.

Abfrageparameter¶

limit int32

Maximale Anzahl der Elemente pro Seite.

page_token string

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

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

object

Installation beschreibt eine Anwendungsinstallation. Anwendungen können für einzelne Mandanten oder für eine gesamte Organisation installiert werden. Bei organisationsweiten Installationen ist tenant_id leer. Verwenden Sie die API zur Auflistung der Mandanten einer Organisation, um die Mandanten der mit der Installation verknüpften Organisation zu ermitteln.

tenant_id string

ID des Mandanten, in dem die Anwendung installiert ist. Bei organisationsweiten Installationen leer.

org_id string

ID der Organisation, in der die Anwendung installiert ist. Bei Installationen für einzelne Mandanten leer.

Antwortbeispiel¶

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