Listar los inquilinos de una organización.¶

Método¶

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

Descripción¶

Lista los inquilinos del identificador de organización especificado. Utilice los parámetros de consulta limit y page_token para paginar los inquilinos.

Parámetros de ruta¶

org_id string obligatorio

Identificador de la organización cuyos inquilinos 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

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

Esquema de respuesta correcta (200)¶

object

TenantsPage contiene los resultados del listado de inquilinos de la organización.

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 inquilinos.

object

Tenant describe un único inquilino.

id string

Identificador único del inquilino.

external_id string

Identificador externo (Google Workspace, Microsoft 365, etc.) del inquilino.

kind string

Tipo de inquilino (`gsuite` para Google Workspace, `o365` para Microsoft 365, etc.).

name string

Nombre del inquilino. En los inquilinos de Google Workspace y Microsoft 365, suele ser el nombre de dominio.

region string

Región en la que reside el inquilino. Código de país o territorio de dos letras conforme a ISO 3166-1 alfa-2 (por ejemplo, US, CA, AU, UK, EU, DE y CH).

deleted boolean

True si se ha cancelado el inquilino y ya no puede consultarse. Las suscripciones de inquilinos eliminados utilizan el estado `canceled`.

Ejemplo de respuesta¶

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