Saltar a contenido

Listar organizaciones secundarias.

Método

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

Descripción

Lista las organizaciones secundarias de la organización principal especificada. La organización raíz y sus suborganizaciones forman una jerarquía. Cada organización de la jerarquía puede ser propietaria de inquilinos y recursos.

Utilice los parámetros de consulta limit y page_token para paginar la jerarquía.

Parámetros de ruta
org_id string obligatorio

ID de la organización principal cuyas organizaciones secundarias se listarán.

Parámetros de consulta
limit int32

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

page_token string

Token de la operación de listado anterior (`next_page_token`) que se utiliza para continuar el listado.

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 de la página siguiente de la operación de listado. Establezca este valor como `page_token` en la solicitud posterior. 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, 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"
    }
  ]
}