Obtener un inquilino.¶

Método¶

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

Descripción¶

Obtiene un inquilino por su ID.

Parámetros de ruta¶

id string obligatorio

ID del inquilino solicitado.

curl

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

Esquema de respuesta correcta (200)¶

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¶

{
  "id": "string",
  "external_id": "string",
  "kind": "string",
  "name": "string",
  "region": "string",
  "deleted": true
}