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 Organisation auf oberster Ebene und ihre Unterorganisationen bilden eine Hierarchie. Jeder Organisation in der Hierarchie können Mandanten und Ressourcen zugeordnet sein.

Mit den Abfrageparametern limit und page_token rufen Sie die Hierarchie seitenweise ab.

Pfadparameter
org_id string erforderlich

ID der übergeordneten Organisation, deren Unterorganisationen aufgelistet werden.

Abfrageparameter
limit int32

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

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

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

object

Org stellt eine Organisation dar.
id string

Eindeutige ID der Organisation.
external_id string

Eindeutige externe ID der Organisation.
kind string

Organisationstyp (distributor, msp, basic).
name string

Name der Organisation.

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