REST Resource: partners.customers

Recurso: Company

Un distribuidor, un proveedor o un cliente en las API de distribuidor y cliente con inscripción automática

Representación JSON
{
  "name": string,
  "companyId": string,
  "companyName": string,
  "ownerEmails": [
    string
  ],
  "adminEmails": [
    string
  ],
  "termsStatus": enum (TermsStatus),
  "skipWelcomeEmail": boolean,
  "languageCode": string,
  "googleWorkspaceAccount": {
    object (GoogleWorkspaceAccount)
  }
}
Campos
name

string

Solo salida. El nombre del recurso de la API de la empresa. El nombre del recurso está en uno de los siguientes formatos:

  • partners/[PARTNER_ID]/customers/[CUSTOMER_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]

El servidor lo asigna.

companyId

string (int64 format)

Solo salida. Es el ID de la empresa. El servidor lo asigna.

companyName

string

Obligatorio. El nombre de la empresa. Por ejemplo, XYZ Corp. Se muestra a los empleados de la empresa en el portal de inscripción automática.

ownerEmails[]

string

Obligatorio. Solo entrada. Dirección de correo electrónico de los usuarios del cliente con la función de propietario Se requiere al menos un owner_email. Los propietarios comparten el mismo acceso que los administradores, pero también pueden agregar, borrar y editar los usuarios del portal de su organización.

adminEmails[]

string

Opcional. Dirección de correo electrónico de los usuarios del cliente con función de administrador Cada dirección de correo electrónico debe estar asociada con una Cuenta de Google.

termsStatus

enum (TermsStatus)

Solo salida. Indica si algún usuario de la empresa aceptó las Condiciones del Servicio más recientes. Consulta los TermsStatus.

skipWelcomeEmail

boolean

Solo entrada. Si se establece como verdadera, no se enviará un correo electrónico de bienvenida al cliente. Se recomienda omitir el correo electrónico de bienvenida si se reclamarán dispositivos con el servicio DEVICE_PROTECTION adicional, ya que el cliente recibirá correos electrónicos separados en el momento del reclamo de dispositivo. Este campo se ignora si no se trata de un cliente de inscripción automática.

languageCode

string

Solo entrada. Es la configuración regional preferida del cliente representada como un código de idioma BCP47. Este campo se valida en la entrada y se rechazarán las solicitudes que contengan códigos de idioma no admitidos. Nota:

googleWorkspaceAccount

object (GoogleWorkspaceAccount)

Solo salida. La cuenta de Google Workspace asociada con este cliente. Solo se usa para las empresas del cliente.

Estado de las condiciones

Aceptación de las Condiciones del Servicio de la inscripción automática de las empresas. Un solo usuario puede aceptar las Condiciones del Servicio de su empresa a través del portal web.

Las Condiciones del Servicio tienen control de versiones. Esto significa que, cuando cambian las Condiciones del Servicio, al menos un usuario debe aceptarlas. Hasta el primer usuario que acepte las nuevas Condiciones del Servicio, el estado de las condiciones de la empresa es TERMS_STATUS_STALE.

Enumeradores
TERMS_STATUS_NOT_ACCEPTED Ninguno de los usuarios de la empresa ha aceptado las Condiciones del Servicio.
TERMS_STATUS_ACCEPTED Uno (o más) de los usuarios de la empresa aceptaron las Condiciones del Servicio.
TERMS_STATUS_STALE Ninguno de los usuarios de la empresa aceptó las Condiciones del Servicio actuales, pero al menos uno de los usuarios aceptó una anterior.

Cuenta de Google Workspace

Un cliente de Google Workspace.

Representación JSON
{
  "customerId": string,
  "preProvisioningTokens": [
    string
  ]
}
Campos
customerId

string

Obligatorio. El ID de cliente.

preProvisioningTokens[]

string

Solo salida. Los tokens de preaprovisionamiento utilizados anteriormente para reclamar dispositivos.

Métodos

create

Crea un cliente para la inscripción automática.

list

Enumera los clientes que están inscritos al distribuidor identificado por el argumento partnerId.