REST Resource: users

{
  "id": string,
  "primaryEmail": string,
  "password": value,
  "hashFunction": string,
  "isAdmin": boolean,
  "isDelegatedAdmin": boolean,
  "agreedToTerms": boolean,
  "suspended": boolean,
  "changePasswordAtNextLogin": boolean,
  "ipWhitelisted": boolean,
  "name": {
    object (UserName)
  },
  "kind": string,
  "etag": string,
  "emails": value,
  "externalIds": value,
  "relations": value,
  "aliases": [
    string
  ],
  "isMailboxSetup": boolean,
  "customerId": string,
  "addresses": value,
  "organizations": value,
  "lastLoginTime": string,
  "phones": value,
  "suspensionReason": string,
  "thumbnailPhotoUrl": string,
  "languages": value,
  "posixAccounts": value,
  "creationTime": string,
  "nonEditableAliases": [
    string
  ],
  "sshPublicKeys": value,
  "notes": value,
  "websites": value,
  "locations": value,
  "includeInGlobalAddressList": boolean,
  "keywords": value,
  "deletionTime": string,
  "gender": value,
  "thumbnailPhotoEtag": string,
  "ims": value,
  "customSchemas": value,
  "isEnrolledIn2Sv": boolean,
  "isEnforcedIn2Sv": boolean,
  "archived": boolean,
  "orgUnitPath": string,
  "recoveryEmail": string,
  "recoveryPhone": string
}

string

O ID exclusivo do usuário. Um id de usuário pode ser utilizado como o userKey do URI de solicitação do usuário.

string

O endereço de e-mail principal do usuário. Essa propriedade é obrigatória em uma solicitação para criar uma conta de usuário. O primaryEmail precisa ser único e não pode ser um alias de outro usuário.

value (Value format)

Armazena a senha da conta do usuário. O valor da senha do usuário é obrigatório ao criar uma conta de usuário. Ela é opcional na atualização de um usuário e só deve ser fornecida se o usuário estiver atualizando a senha da conta. O valor da senha nunca é retornado no corpo da resposta da API.

Uma senha pode conter qualquer combinação de caracteres ASCII e precisa ter entre 8 e 100 caracteres.

Recomendamos enviar o parâmetro password como um valor de hash codificado em hexadecimal e definir hashFunction corretamente. Se hashFunction for especificado, a senha precisará ser uma chave de hash válida.

string

Armazena o formato de hash da propriedade password. Os seguintes valores hashFunction são permitidos:

• MD5: aceita valores simples codificados em hexadecimal.
• SHA-1: aceita valores simples codificados em hexadecimal.
• crypt: em conformidade com a biblioteca C crypt. Oferece suporte aos algoritmos de hash DES, MD5 (prefixo de hash $1$), SHA-256 (prefixo de hash $5$) e SHA-512 (prefixo de hash $6$).

Se os rounds forem especificados como parte do prefixo, eles precisarão ser 10.000 ou menos.

boolean

Apenas saída. Indica um usuário com privilégios de superadministrador. A propriedade isAdmin só pode ser editada na operação Tornar um usuário um administrador ( método makeAdmin). Se for editada nos métodos insert ou update do usuário, a edição será ignorada pelo serviço da API.

boolean

Apenas saída. Indica se o usuário é um administrador delegado.
Administradores delegados são compatíveis com a API, mas não podem criar usuários, cancelar a exclusão nem tornar usuários administradores. Essas solicitações são ignoradas pelo serviço da API.
As funções e os privilégios dos administradores são atribuídos no Admin Console.

boolean

Apenas saída. Esta propriedade será true se o usuário tiver concluído um login inicial e aceito o contrato dos Termos de Serviço.

boolean

Indica se o usuário está suspenso.

boolean

Indica se o usuário é forçado a alterar a senha no próximo login. Essa configuração não se aplica quando o usuário faz login com um provedor de identidade de terceiros.

boolean

Se for true, o endereço IP do usuário estará sujeito a uma configuração de endereço IP descontinuada allowlist.

object (UserName)

Mantém o nome e o sobrenome do usuário e o valor somente leitura de fullName. O número máximo de caracteres nos valores givenName e familyName é 60. Além disso, os valores de nome são compatíveis com caracteres unicode/UTF-8 e podem conter espaços, letras (a-z), números (0-9), traços (-), barras (/) e pontos (.). Para saber mais sobre as regras de uso de caracteres, consulte a Central de Ajuda sobre administração. O tamanho máximo de dados permitido para este campo é 1 KB.

string

Apenas saída. O tipo do recurso da API. Para recursos de usuários, o valor é admin#directory#user.

string

Apenas saída. ETag do recurso.

value (Value format)

A lista de endereços de e-mail do usuário. O tamanho máximo permitido para dados é 10 KB.

value (Value format)

A lista de IDs externos do usuário, como um ID de funcionário ou de rede. O tamanho máximo permitido para os dados é de 2 KB.

value (Value format)

A lista das relações do usuário com outros usuários. O tamanho máximo de dados permitido para este campo é 2 KB. Para mais informações, consulte Gerenciar contas de usuário.

string

Apenas saída. A lista de endereços de e-mail do alias do usuário.

boolean

Apenas saída. Indica se a caixa de e-mails do Google do usuário foi criada. Esta propriedade só é aplicável se o usuário tiver recebido uma licença do Gmail.

string

Apenas saída. O ID de cliente para recuperar todos os usuários da conta.
Você pode usar o alias my_customer para representar o customerId da sua conta.
Como administrador revendedor, você pode usar o customerId da conta de cliente de revenda. Para acessar um customerId, use o domínio principal da conta no parâmetro domain de uma solicitação users.list.

value (Value format)

A lista de endereços do usuário. O tamanho máximo permitido para dados é 10 KB.

value (Value format)

Lista de organizações a que o usuário pertence. O tamanho máximo permitido para dados é 10 KB.

string

Apenas saída. A última vez que o usuário fez login na conta dele. O valor está no formato de data e hora ISO 8601. A hora é a data completa mais horas, minutos e segundos no formato YYYY-MM-DDThh:mm:ssTZD. Por exemplo, 2010-04-05T17:30:04+01:00.

value (Value format)

Uma lista dos números de telefone do usuário. O tamanho máximo permitido para os dados é 1 KB.

string

Apenas saída. O motivo pelo qual uma conta de usuário foi suspensa pelo administrador ou pelo Google no momento da suspensão. A propriedade será retornada somente se a propriedade suspended for true.

string

Apenas saída. O URL da foto do perfil do usuário. O URL pode ser temporário ou particular.

value (Value format)

Lista de idiomas do usuário. O tamanho máximo permitido para os dados é 1 KB.

value (Value format)

A lista de informações da conta POSIX para o usuário.

string

Apenas saída. Hora em que a conta do usuário foi criada. O valor está no formato de data e hora ISO 8601. A hora é a data completa mais horas, minutos e segundos no formato YYYY-MM-DDThh:mm:ssTZD. Por exemplo, 2010-04-05T17:30:04+01:00.

string

Apenas saída. A lista dos endereços de e-mail de alias não editáveis do usuário. Normalmente, eles estão fora do domínio principal ou do subdomínio da conta.

value (Value format)

Uma lista de chaves públicas SSH.

value (Value format)

Observações para o usuário como um objeto aninhado.

value (Value format)

A lista de sites do usuário.

value (Value format)

A lista de locais do usuário. O tamanho máximo permitido para dados é 10 KB.

boolean

Indica se o perfil do usuário está visível na lista de endereços globais do Google Workspace quando o compartilhamento de contatos está ativado no domínio. Para mais informações sobre como excluir perfis de usuários, consulte a Central de Ajuda sobre administração.

value (Value format)

A lista de palavras-chave do usuário. O tamanho máximo permitido para os dados é 1 KB.

string

Apenas saída. A hora em que a conta do usuário foi excluída. O valor está no formato de data e hora ISO 8601. A hora é a data completa mais horas, minutos e segundos no formato YYYY-MM-DDThh:mm:ssTZD. Exemplo:2010-04-05T17:30:04+01:00.

value (Value format)

Um objeto aninhado que contém o gênero do usuário. O tamanho máximo de dados permitido para este campo é 1 KB.

string

Apenas saída. ETag da foto do usuário (somente leitura)

value (Value format)

As contas do Instant Messenger (IM) do usuário. Uma conta de usuário pode ter várias propriedades ims, mas apenas uma dessas propriedades ims pode ser o contato principal de mensagens instantâneas.

value (Value format)

Campos personalizados do usuário. O tamanho máximo permitido para os dados é 32 KB. A chave é um schemaName e os valores dela são 'fieldName': 'field_value'.

• customSchemas.(key) é um objeto aninhado.
• customSchemas.(key).(key) pode ser qualquer valor.

boolean

Apenas saída. está inscrito na verificação em duas etapas (somente leitura);

boolean

Apenas saída. A verificação em duas etapas é aplicada (somente leitura)

boolean

Indica se o usuário está arquivado.

string

O caminho completo da organização mãe associada ao usuário. Se a organização mãe for o nível superior, ela será representada por uma barra (/).

string

E-mail de recuperação do usuário.

string

Telefone de recuperação do usuário. O número de telefone precisa estar no formato E.164, começando com o sinal de adição (+). Exemplo: +16506661212.

{
  "fullName": string,
  "familyName": string,
  "givenName": string,
  "displayName": string
}

string

O nome completo do usuário, formado pela concatenação dos valores de nome e sobrenome.

string

O sobrenome do usuário. Obrigatório ao criar uma conta de usuário.

string

O nome do usuário. Obrigatório ao criar uma conta de usuário.

string

O nome de exibição do usuário. Limite: 256 caracteres.