Zum Inhalt

Untergeordnete Organisationen auflisten.

Methode

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

Beschreibung

Listet die untergeordneten Organisationen der angegebenen übergeordneten Organisation auf. Die Stammorganisation und ihre Unterorganisationen bilden eine Hierarchie. Jede Organisation in der Hierarchie kann Mandanten und Ressourcen besitzen.

Mit den Abfrageparametern limit und page_token können Sie die Hierarchie seitenweise durchlaufen.

Pfadparameter
org_id string erforderlich

ID der übergeordneten Organisation, deren untergeordnete Organisationen aufgelistet werden sollen.

Abfrageparameter
limit int32

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

Token aus dem vorherigen Listenaufruf (`next_page_token`), mit dem die Auflistung fortgesetzt wird.

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

Schema der erfolgreichen Antwort (200)
object

OrgsPage enthält die Ergebnisse der Organisationsauflistung.
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 Organisationen.

object

Org stellt eine Organisation dar.
id string

Eindeutige ID der Organisation.
external_id string

Eindeutige externe ID der Organisation.
kind string

Organisationsart (distributor, msp, basic).
name string

Name der Organisation.

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