Listar las organizaciones subordinadas.¶

Método¶

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

Descripción¶

Lista las organizaciones subordinadas a la organización superior indicada. La organización raíz y sus organizaciones subordinadas forman una jerarquía. Cada organización de la jerarquía puede contener inquilinos y recursos.

Utilice los parámetros de consulta limit y page_token para recorrer la jerarquía página por página.

Parámetros de ruta¶

org_id string obligatorio

ID de la organización superior cuyas organizaciones subordinadas se van a listar.

Parámetros de consulta¶

limit int32

Número máximo de elementos por página (valor predeterminado: 100).

page_token string

Token de la operación de listado anterior (next_page_token) que permite continuar el listado.

curl

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

Esquema de respuesta correcta (200)¶

object

OrgsPage contiene los resultados del listado de organizaciones.

next_page_token string

Token para obtener la página siguiente del listado. Envíelo como page_token en la siguiente solicitud. Está vacío en la última página.

items array of objects

Lista de organizaciones.

object

Org representa una organización.

id string

ID único de la organización.

external_id string

ID externo único de la organización.

kind string

Tipo de organización (distributor, msp o basic).

name string

Nombre de la organización.

Ejemplo de respuesta¶

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