REST Resource: users

Recurso: User

Com a API Directory, você pode criar e gerenciar os usuários, os pseudônimos e as fotos de perfil do Google da sua conta. Para mais informações sobre tarefas comuns, consulte o Guia para desenvolvedores de contas de usuário e o Guia para desenvolvedores de pseudônimos de usuário.

Representação JSON 
{
  "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
}
Campos
id

string

O ID exclusivo do usuário. Um id do usuário pode ser usado como userKey do URI da solicitação do usuário.
primaryEmail

string

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

value (Value format)

Armazena a senha da conta de usuário. O valor da senha do usuário é obrigatório ao criar uma conta de usuário. É opcional ao atualizar um usuário e só deve ser fornecido 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.
hashFunction

string

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

  • MD5: aceita valores simples codificados em hexadecimal.
  • SHA-1: aceita valores simples codificados em hexadecimal.
  • crypt: é compatível com a biblioteca de criptografia C (link em inglês). 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 as rodadas forem especificadas como parte do prefixo, elas precisarão ter até 10.000.
isAdmin

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 administrador ( método makeAdmin). Se for editado nos métodos insert ou update do usuário, a edição será ignorada pelo serviço da API.
isDelegatedAdmin

boolean

Apenas saída. Indica se o usuário é um administrador delegado.
Os administradores delegados têm suporte da API, mas não podem criar ou desfazer a exclusão de usuários 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 usando o Admin Console.
agreedToTerms

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.
suspended

boolean

Indica se o usuário está suspenso.
changePasswordAtNextLogin

boolean

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

boolean

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

object (UserName)

Contém o nome e o sobrenome do usuário, além do valor fullName somente leitura. O número máximo de caracteres nos valores givenName e familyName é 60. Além disso, os valores de nome aceitam caracteres Unicode/UTF-8 e podem conter espaços, letras (a-z), números (0-9), traços (-), barras (/) e pontos (.). Para mais informações sobre as regras de uso de caracteres, consulte a central de ajuda de administração. O tamanho máximo de dados permitido para esse campo é 1 KB.
kind

string

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

string

Apenas saída. ETag do recurso.
emails

value (Value format)

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

Campos

emails[].address

string

O endereço de e-mail do usuário. Também serve como o ID de e-mail. Esse valor pode ser o endereço de e-mail principal do usuário ou um alias.

emails[].customType

string

Se o endereço de e-mail type for custom, essa propriedade conterá o valor personalizado e precisará ser definida.

emails[].primary

boolean

Indica se esse é o e-mail principal do usuário. Somente uma entrada pode ser marcada como principal.

emails[].type

string

O tipo de conta de e-mail. Se definido como custom, customType também precisa ser definido.

Valores aceitos: custom, home, other, work.
externalIds

value (Value format)

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

Campos

externalIds[].customType

string

Se o ID externo type for custom, essa propriedade vai conter o valor personalizado e precisará ser definida.

externalIds[].type

string

O tipo de ID externo. Se definido como custom, customType também precisa ser definido.

Valores aceitos: account, custom, customer, login_id, network, organization.

externalIds[].value

string

O valor do ID externo.
relations

value (Value format)

Lista de relacionamentos do usuário com outros usuários. O tamanho máximo de dados permitido para esse campo é de 2 KB. Para mais informações, consulte Gerenciar contas de usuário.

Campos

relations[].customType

string

Se a relação type for custom, esta propriedade conterá o valor personalizado e precisará ser definida.

relations[].type

string

O tipo de relação. Se definido como custom, customType também precisa ser definido.

Valores aceitáveis:
  • admin_assistant
  • assistant
  • brother
  • child
  • custom
  • domestic_partner
  • dotted_line_manager
  • exec_assistant
  • father
  • friend
  • manager
  • mother
  • parent
  • partner
  • referred_by
  • relative
  • sister
  • spouse

relations[].value

string

O endereço de e-mail da pessoa com quem o usuário tem relação.
aliases[]

string

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

boolean

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

string

Apenas saída. O ID do 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 do revendedor, você pode usar o customerId da conta do cliente de revenda. Para receber um customerId, use o domínio principal da conta no parâmetro domain de uma solicitação users.list.
addresses

value (Value format)

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

Campos

addresses[].country

string

País.

addresses[].countryCode

string

O código do país. Usa o padrão ISO 3166-1.

addresses[].customType

string

Se o endereço type for custom, essa propriedade vai conter o valor personalizado e precisará ser definida.

addresses[].extendedAddress

string

Para endereços estendidos, como um endereço que inclui uma sub-região.

addresses[].formatted

string

Um endereço postal completo e não estruturado. Isso não é sincronizado com os campos de endereço estruturados. Inclui os seguintes atributos: endereço, caixa postal, cidade, estado/província, CEP/código postal, país/região.

addresses[].locality

string

Cidade do endereço.

addresses[].poBox

string

A caixa postal, se houver.

addresses[].postalCode

string

O CEP, se aplicável.

addresses[].primary

boolean

Se esse for o endereço principal do usuário. A lista de endereços pode conter apenas um endereço principal.

addresses[].region

string

A província ou o estado abreviado.

addresses[].sourceIsStructured

boolean

Indica se o endereço fornecido pelo usuário foi formatado. No momento, não é possível usar endereços formatados.

addresses[].streetAddress

string

O endereço, como 1600 Amphitheatre Parkway. O espaço em branco na string é ignorado. No entanto, as novas linhas são significativas.

addresses[].type

string

O tipo de endereço. Se definido como custom, customType também precisará ser definido.

Valores aceitáveis: custom, home, other, work.
organizations

value (Value format)

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

Campos

organizations[].costCenter

string

O centro de custo da organização do usuário.

organizations[].customType

string

Se o valor do tipo for personalizado, essa propriedade vai conter o tipo personalizado.

organizations[].department

string

Especifica o departamento dentro da organização, como sales ou engineering.

organizations[].description

string

A descrição da organização.

organizations[].domain

string

O domínio a que a organização pertence.

organizations[].fullTimeEquivalent

integer

A milésima parte equivalente a tempo integral na organização (100000 = 100%).

organizations[].location

string

É a localização física da organização. Ele não precisa ser um endereço totalmente qualificado.

organizations[].name

string

É o nome da organização.

organizations[].primary

boolean

Indica se esta é a organização principal do usuário. Um usuário só pode ter uma organização principal.

organizations[].symbol

string

Símbolo de string de texto da organização. Por exemplo, o símbolo de texto do Google é GOOG.

organizations[].title

string

O cargo do usuário na organização. Por exemplo, member ou engineer.

organizations[].type

string

O tipo de organização.

Valores aceitáveis: domain_only, school, unknown, work.
lastLoginTime

string

Apenas saída. A última vez que o usuário fez login na conta. 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.
phones

value (Value format)

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

Campos

phones[].customType

string

Se o número de telefone type for custom, esta propriedade conterá o valor personalizado e precisará ser definida.

phones[].primary

boolean

Se for true, esse é o número de telefone principal do usuário. Um usuário só pode ter um número de telefone principal.

phones[].type

string

O tipo de número de telefone. Se definido como custom, customType também precisa ser definido.

Valores aceitos: assistant, callback, car, company_main, custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager.

phones[].value

string

Um número de telefone legível para seres humanos. Ele pode estar em qualquer formato de número de telefone.
suspensionReason

string

Apenas saída. Mostra o motivo da suspensão de uma conta de usuário pelo administrador ou pelo Google no momento da suspensão. A propriedade só é retornada se suspended for true.
thumbnailPhotoUrl

string

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

value (Value format)

A lista dos idiomas do usuário. O tamanho máximo permitido de dados é 1 KB.

Campos

languages[].customLanguage

string

Outro idioma. O usuário pode fornecer o próprio nome do idioma se não houver um código de idioma ISO 639 correspondente. Se esse valor for definido, não será possível definir languageCode.

languages[].languageCode

string

Representação de string ISO 639 de um idioma. Consulte Códigos de idioma para conferir a lista de códigos aceitos. Os códigos de idioma válidos fora do conjunto aceito pela API serão aceitos, mas podem causar um comportamento inesperado. Valores ilegais causam SchemaException. Se esse valor for definido, não será possível definir customLanguage.

languages[].preference

string

Opcional. Se presente, controla se o languageCode especificado é o idioma preferido do usuário. Se customLanguage estiver definido, não será possível definir esse valor. Os valores permitidos são preferred e not_preferred.
posixAccounts

value (Value format)

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

Campos

posixAccounts[].accountId

string

Um identificador de campo da conta no formato POSIX.

posixAccounts[].gecos

string

Os GECOS (informações do usuário) dessa conta.

posixAccounts[].gid

unsigned long

O ID do grupo padrão.

posixAccounts[].homeDirectory

string

O caminho para o diretório principal dessa conta.

posixAccounts[].operatingSystemType

string

O tipo de sistema operacional da conta.

Valores aceitos: linux, unspecified, windows.

posixAccounts[].primary

boolean

Se essa for a conta principal do usuário em SystemId.

posixAccounts[].shell

string

O caminho para o shell de login dessa conta.

posixAccounts[].systemId

string

Identificador do sistema para a conta a que o nome de usuário ou o ID do usuário se aplicam.

posixAccounts[].uid

unsigned long

O ID do usuário compatível com POSIX.

posixAccounts[].username

string

O nome de usuário da conta.
creationTime

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.
nonEditableAliases[]

string

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

value (Value format)

Uma lista de chaves públicas SSH.

Campos

sshPublicKeys[].expirationTimeUsec

long

Período de expiração em microssegundos a partir do início.

sshPublicKeys[].fingerprint

string

Uma impressão digital SHA-256 da chave pública do SSH. (Somente leitura)

sshPublicKeys[].key

string

Uma chave pública SSH.
notes

value (Value format)

Notas para o usuário como um objeto aninhado.

Campos

notes.contentType

string

Tipo de conteúdo da nota, texto simples ou HTML. O padrão é texto simples.

Valores aceitos: text_plain, text_html.

notes.value

string

Conteúdo das anotações.
websites

value (Value format)

A lista dos sites do usuário.

Campos

websites[].customType

string

Se o type do site for custom, essa propriedade conterá o valor personalizado e precisará ser definida.

websites[].primary

boolean

Se for true, esse é o site principal do usuário.

websites[].type

string

O tipo ou a finalidade do site. Por exemplo, um site pode ser rotulado como home ou blog. Uma entrada também pode ter um tipo custom. Se definido como custom, customType também precisa ser definido.

Valores aceitos: app_install_page, blog, custom, ftp, home, home_page, other, profile, reservations, resume, work.

websites[].value

string

O URL do site.
locations

value (Value format)

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

Campos

locations[].area

string

Localização textual. Ele é mais útil para exibir uma descrição concisa do local. Por exemplo, Mountain View, CA ou Near Seattle.

locations[].buildingId

string

Identificador do edifício.

locations[].customType

string

Se o local type for custom, essa propriedade conterá o valor personalizado e precisará ser definida.

locations[].deskCode

string

Código textual mais específico do local da mesa individual.

locations[].floorName

string

Nome/número do andar.

locations[].floorSection

string

Seção do andar. Local mais específico dentro do andar. Por exemplo, se um andar for dividido nas seções A, B e C, esse campo vai identificar um desses valores.

locations[].type

string

O tipo de local. Se definido como custom, customType também precisa ser definido.

Valores aceitos: custom, default, desk.
includeInGlobalAddressList

boolean

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

value (Value format)

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

Campos

keywords[].customType

string

Se a palavra-chave type for custom, essa propriedade conterá o valor personalizado e precisará ser definida.

keywords[].type

string

Cada entrada pode ter um tipo que indica o tipo padrão dela.

Por exemplo, a palavra-chave pode ser do tipo occupation ou outlook. Além do tipo padrão, uma entrada pode ter um tipo custom e receber qualquer nome. Se definido como custom, customType também precisará ser definido.

Valores aceitáveis: custom, mission, occupation, outlook.

keywords[].value

string

Palavra-chave.
deletionTime

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
gender

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.

Campos

gender.addressMeAs

string

Uma string legível por humanos que contém a maneira adequada de se referir ao proprietário do perfil, por exemplo, "ele/ele/seu" ou "eles/elas/deles".

gender.customGender

string

Nome de um gênero personalizado.

gender.type

string

 O tipo de gênero.

Valores aceitos:
  • female
  • male
  • other
  • unknown

thumbnailPhotoEtag

string

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

value (Value format)

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

Campos

ims[].customProtocol

string

Se o valor do protocolo for custom_protocol, essa propriedade vai conter a string do protocolo personalizado.

ims[].customType

string

Se o type do IM for custom, essa propriedade vai conter o valor personalizado e precisará ser definida.

ims[].im

string

O ID da rede de mensagens instantâneas do usuário.

ims[].primary

boolean

Se for o mensageiro principal do usuário. Apenas uma entrada na lista de mensagens instantâneas pode ter um valor verdadeiro.

ims[].protocol

string

 Um protocolo de mensagem instantânea identifica a rede de mensagem instantânea. O valor pode ser uma rede personalizada ou a rede padrão.

Valores aceitos:
  • aim: protocolo do AOL Instant Messenger
  • custom_protocol: um protocolo de rede de mensagens instantâneas personalizado
  • gtalk: protocolo do Google Talk
  • icq: protocolo ICQ
  • jabber: protocolo Jabber
  • msn: protocolo MSN Messenger
  • net_meeting: protocolo do Net Meeting
  • qq: protocolo QQ
  • skype: protocolo do Skype
  • yahoo: protocolo do Yahoo Messenger

ims[].type

string

O tipo de conta de mensagens instantâneas. Se definido como custom, customType também precisa ser definido.

Valores aceitos: custom, home, other, work.
customSchemas

value (Value format)

Campos personalizados do usuário. A chave é um schemaName e os valores são 'fieldName': 'field_value'.

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

boolean

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

boolean

Apenas saída. A verificação em duas etapas é obrigatória (somente leitura)
archived

boolean

Indica se o usuário está arquivado.
orgUnitPath

string

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

string

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

string

Número de 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.

UserName

Representação JSON 
{
  "fullName": string,
  "familyName": string,
  "givenName": string,
  "displayName": string
}
Campos
fullName

string

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

string

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

string

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

string

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

Métodos

delete

 Exclui um usuário.

get

 Recupera um usuário.

insert

 Cria um usuário.

list

 Recupera uma lista paginada de usuários excluídos ou de todos os usuários em um domínio.

makeAdmin

 Torna um usuário superadministrador.

patch

 Atualiza um usuário usando a semântica de patch.

signOut

 Desconecta o usuário de todas as sessões da Web e do dispositivo e redefine os cookies de login.

undelete

 Desfaz a exclusão de um usuário.

update

 Atualiza um usuário.

watch

 Observa mudanças na lista de usuários.