Aller au contenu

Répertorier les organisations enfants.

Méthode

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

Description

Répertorie les organisations enfants de l’organisation parente indiquée. L’organisation racine et ses sous-organisations forment une hiérarchie. Chaque organisation de la hiérarchie peut posséder des locataires et des ressources.

Utilisez les paramètres de requête limit et page_token pour parcourir la hiérarchie page par page.

Paramètres de chemin
org_id string obligatoire

Identifiant de l’organisation parente dont les organisations enfants doivent être répertoriées.

Paramètres de requête
limit int32

Nombre maximal d’éléments à renvoyer par page (100 par défaut).

page_token string

Jeton de l’opération de liste précédente (`next_page_token`) utilisé pour poursuivre l’énumération.

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

Schéma de la réponse réussie (200)
object

OrgsPage contient les résultats de l’énumération des organisations.

next_page_token string

Jeton de la page suivante dans l’opération d’énumération. Définissez cette valeur comme `page_token` dans la requête suivante. Vide sur la dernière page.

items array of objects

Liste des organisations.

object

Org représente une organisation.

id string

Identifiant unique de l’organisation.

external_id string

Identifiant externe unique de l’organisation.

kind string

Type d’organisation (distributor, msp, basic).

name string

Nom de l’organisation.

Exemple de réponse
{
  "next_page_token": "string",
  "items": [
    {
      "id": "string",
      "external_id": "string",
      "kind": "string",
      "name": "string"
    }
  ]
}