Saltar a contenido

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 de la organización cuyo ID se indica. Utilice los parámetros de consulta limit y page_token para recorrer los inquilinos página por página.

Parámetros de ruta
org_id string obligatorio

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

object

Tenant describe un inquilino.
id string

ID único del inquilino.
external_id string

ID externo del inquilino (en Google Workspace, Microsoft 365, etc.).
kind string

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

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

Región de Afi en la que se aloja el inquilino. Código de región de dos letras basado en ISO 3166-1 alfa-2, incluidos los códigos reservados de forma excepcional UK y EU (por ejemplo, US, CA, AU, UK, EU, DE o CH).
deleted boolean

Es true si el inquilino se ha dado de baja y ya no puede consultarse. Las suscripciones de los inquilinos dados de baja tienen el estado canceled.

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