Obtener un inquilino.¶

Método¶

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

Descripción¶

Obtiene un inquilino mediante su identificador.

Parámetros de ruta¶

id string obligatorio

Identificador del inquilino que se obtendrá.

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 ú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¶

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