Répertorier les sous-organisations.¶

Méthode¶

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

Description¶

Répertorie les sous-organisations de l’organisation parente indiquée. L’organisation racine et ses sous-organisations forment une hiérarchie. Chaque organisation de cette hiérarchie peut contenir 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.

Paramètres de requête¶

limit int32

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

page_token string

Jeton renvoyé par l’appel précédent (next_page_token), à utiliser pour obtenir la suite des résultats.

curl

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

Schéma de la réponse en cas de succès (200)¶

object

OrgsPage contient les organisations renvoyées sur cette page.

next_page_token string

Jeton permettant d’obtenir la page suivante. Transmettez cette valeur dans le paramètre page_token de la requête suivante. Le jeton est 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 ou 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"
    }
  ]
}