REST Resource: partners.customers

Ressource : Company

Un revendeur, un fournisseur ou un client dans les API revendeur et client d'enregistrement sans contact.

Représentation JSON
{
  "name": string,
  "companyId": string,
  "companyName": string,
  "ownerEmails": [
    string
  ],
  "adminEmails": [
    string
  ],
  "termsStatus": enum (TermsStatus),
  "skipWelcomeEmail": boolean,
  "languageCode": string,
  "googleWorkspaceAccount": {
    object (GoogleWorkspaceAccount)
  }
}
Champs
name

string

Uniquement en sortie. Nom de ressource d'API de l'entreprise. Le nom de la ressource est dans l'un des formats suivants:

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

Attribué par le serveur.

companyId

string (int64 format)

Uniquement en sortie. Identifiant de l'entreprise. Attribué par le serveur.

companyName

string

Obligatoire. Nom de l'entreprise. Par exemple, Société XYZ. Affiché aux employés de l'entreprise sur le portail d'enregistrement sans contact.

ownerEmails[]

string

Obligatoire. Uniquement en entrée. Adresse e-mail des utilisateurs du client avec le rôle de propriétaire. Veuillez indiquer au moins un élément owner_email. Les propriétaires partagent le même accès que les administrateurs, mais peuvent aussi ajouter, supprimer et modifier les utilisateurs du portail de votre entreprise.

adminEmails[]

string

Facultatif. Adresse e-mail des utilisateurs du client avec le rôle d'administrateur. Chaque adresse e-mail doit être associée à un compte Google.

termsStatus

enum (TermsStatus)

Uniquement en sortie. Indique si un utilisateur de l'entreprise a accepté les dernières conditions d'utilisation. Consultez les TermsStatus.

skipWelcomeEmail

boolean

Uniquement en entrée. Si cette règle est définie sur "True", l'e-mail de bienvenue n'est pas envoyé au client. Nous vous recommandons d'ignorer l'e-mail de bienvenue si les appareils sont revendiqués par le service DEVICE_PROTECTION supplémentaire, car le client recevra des e-mails distincts au moment de la revendication de l'appareil. Ce champ est ignoré s'il ne s'agit pas d'un client sans contact.

languageCode

string

Uniquement en entrée. Paramètres régionaux préférés du client représenté sous la forme d'un code de langue BCP47. Ce champ est validé à l'aide de la saisie et les requêtes contenant des codes de langue non pris en charge seront refusées.

googleWorkspaceAccount

object (GoogleWorkspaceAccount)

Uniquement en sortie. Le compte Google Workspace associé à ce client. Utilisé uniquement pour les entreprises clientes.

TermsStatus

L'acceptation par une entreprise des conditions d'utilisation de l'enregistrement sans contact Un seul utilisateur peut accepter les conditions d'utilisation pour son entreprise via le portail Web.

Les conditions d'utilisation font l'objet d'une version. Cela signifie que lorsque les conditions d'utilisation sont modifiées, au moins un utilisateur doit les accepter. Tant que le premier utilisateur n'a pas accepté les nouvelles conditions d'utilisation, les conditions d'utilisation de l'entreprise sont à l'état TERMS_STATUS_STALE.

Enums
TERMS_STATUS_NOT_ACCEPTED Aucun des utilisateurs de l'entreprise n'a accepté les conditions d'utilisation.
TERMS_STATUS_ACCEPTED Un ou plusieurs utilisateurs de l'entreprise ont accepté les conditions d'utilisation.
TERMS_STATUS_STALE Aucun des utilisateurs de l'entreprise n'a accepté les conditions d'utilisation actuelles, mais au moins un utilisateur a accepté les conditions d'utilisation précédentes.

GoogleWorkspaceAccount

Un client Google Workspace

Représentation JSON
{
  "customerId": string,
  "preProvisioningTokens": [
    string
  ]
}
Champs
customerId

string

Obligatoire. Numéro client.

preProvisioningTokens[]

string

Uniquement en sortie. Jetons de pré-provisionnement précédemment utilisés pour revendiquer des appareils.

Méthodes

create

Crée un client pour l'enregistrement sans contact.

list

Liste les clients enregistrés auprès du revendeur identifié par l'argument partnerId.