REST Resource: users

Recurso: User

Com a API Directory, você pode criar e gerenciar os usuários, os aliases de usuário e as fotos do perfil de chat do Gmail da sua conta. Para mais informações sobre tarefas comuns, consulte o Guia do desenvolvedor de contas de usuário e o Guia do desenvolvedor sobre aliases de usuários.

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 usuário id pode ser usado como userKey do URI de solicitação do usuário.

primaryEmail

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 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. Ela é opcional ao atualizar 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 adequadamente. 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 hashFunction são permitidos:

  • MD5: aceita valores codificados em hexadecimal simples.
  • SHA-1: aceita valores codificados em hexadecimal simples.
  • crypt: em conformidade com a biblioteca C crypt (link em inglês). Compatível com os 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 no máximo 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 Transformar um usuário em administrador (método makeAdmin). Se editada no método de insert ou update do usuário, a edição será ignorada pelo serviço de API.

isDelegatedAdmin

boolean

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

agreedToTerms

boolean

Apenas saída. Essa 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 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.

ipWhitelisted

boolean

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

name

object (UserName)

Mantém os nomes fornecidos e fornecidos pelo usuário e o valor somente leitura 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 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 do 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, esta propriedade conterá o valor personalizado e precisará ser definida.

emails[].primary

boolean

Indica se este é o e-mail principal do usuário. Só uma entrada pode ser marcada como principal.

emails[].type

string

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

Valores aceitáveis: 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, esta propriedade conterá o valor personalizado e deverá ser definida.

externalIds[].type

string

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

Valores aceitáveis: account, custom, customer, login_id, network, organization.

externalIds[].value

string

O valor do ID externo.

relations

value (Value format)

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

Campos

relations[].customType

string

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

relations[].type

string

É o tipo de relação. Se definido como custom, o customType também precisará 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 está relacionado.

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. Ela só será aplicável se o usuário tiver uma licença do Gmail.

customerId

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 de revendedores, você pode usar o customerId da conta de 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)

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, esta propriedade conterá o valor personalizado e deverá ser definida.

addresses[].extendedAddress

string

Para endereços estendidos, como um endereço que inclua 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 estruturado. Inclui os seguintes atributos: endereço, caixa postal, cidade, estado/província, CEP/código postal, país/região.

addresses[].locality

string

A cidade do endereço.

addresses[].poBox

string

A caixa postal, se presente.

addresses[].postalCode

string

É o CEP ou o código postal, se aplicável.

addresses[].primary

boolean

Se o endereço for 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. Endereços formatados não são compatíveis no momento.

addresses[].streetAddress

string

O endereço, como 1600 Amphitheatre Parkway. O espaço em branco na string é ignorado, mas 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, esta propriedade conterá o tipo personalizado.

organizations[].department

string

Especifica o departamento na 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

O milissegundo equivalente em tempo integral na organização (100.000 = 100%).

organizations[].location

string

É a localização física da organização. 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. Cada usuário só pode ter uma organização principal.

organizations[].symbol

string

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

organizations[].title

string

O título 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 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.

phones

value (Value format)

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

Campos

phones[].customType

string

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

phones[].primary

boolean

Se true, esse é o número de telefone principal do usuário. Cada 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 precisará ser definido.

Valores aceitáveis: 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_fax,

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. Tem o motivo de uma conta de usuário ser suspensa pelo administrador ou pelo Google no momento da suspensão. A propriedade será retornada somente se a propriedade suspended for true.

thumbnailPhotoUrl

string

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

languages

value (Value format)

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

Campos

languages[].customLanguage

string

Outro idioma. O usuário poderá fornecer um nome de idioma próprio se não houver um código de idioma ISO 639 correspondente. Se a política for definida, não será possível definir o languageCode.

languages[].languageCode

string

Representação de string ISO 639 de um idioma. Consulte Códigos de idioma para ver a lista de códigos compatíveis. A API aceita códigos de idioma válidos fora do conjunto compatível, mas pode resultar em um comportamento inesperado. Valores ilegais causam SchemaException. Se a política for definida, não será possível definir o customLanguage.

languages[].preference

string

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

posixAccounts

value (Value format)

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

Campos

posixAccounts[].accountId

string

Um identificador do campo da conta no formato POSIX.

posixAccounts[].gecos

string

Os GECOS (informações do usuário) para esta 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 para esta conta.

Valores aceitáveis: linux, unspecified, windows.

posixAccounts[].primary

boolean

Se esta for a conta principal do usuário no SystemId.

posixAccounts[].shell

string

O caminho para o shell de login desta conta.

posixAccounts[].systemId

string

Identificador de sistema a que o nome de usuário ou o Uid da conta se aplicam.

posixAccounts[].uid

unsigned long

O ID do usuário em conformidade com POSIX.

posixAccounts[].username

string

O nome de usuário da conta.

creationTime

string

Apenas saída. A 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. Elas costumam estar fora do domínio ou subdomínio principal 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 SSH. (somente leitura)

sshPublicKeys[].key

string

Uma chave pública SSH.

notes

value (Value format)

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

Campos

notes.contentType

string

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

Valores aceitáveis: text_plain, text_html.

notes.value

string

Conteúdo das anotações.

websites

value (Value format)

Lista de sites do usuário.

Campos

websites[].customType

string

Se o site type for custom, esta propriedade conterá o valor personalizado e deverá ser definida.

websites[].primary

boolean

Se for true, este será o site principal do usuário.

websites[].type

string

É o tipo ou o propósito do site. Por exemplo, um site pode ser rotulado como home ou blog. Como alternativa, uma entrada pode ter um tipo custom. Se definido como custom, customType também precisará ser definido.

Valores aceitáveis: 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. Isso é mais útil para descrever a localização de maneira concisa. Por exemplo, Mountain View, CA ou Near Seattle.

locations[].buildingId

string

Identificador do edifício.

locations[].customType

string

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

locations[].deskCode

string

Código textual mais específico da localização individual de um espaço de trabalho.

locations[].floorName

string

Nome/número do andar.

locations[].floorSection

string

Seção do andar. Local mais específico no andar. Por exemplo, se um valor mínimo estiver dividido nas seções A, B e C, esse campo identificará um desses valores.

locations[].type

string

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

Valores aceitáveis: custom, default, desk.

includeInGlobalAddressList

boolean

Indica se o perfil do usuário está visível na lista de endereços global do Google Workspace quando o recurso de compartilhamento de contatos está ativado para o 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, a propriedade vai ter o valor personalizado e vai 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 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 esse campo é 1 KB.

Campos

gender.addressMeAs

string

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

gender.customGender

string

Nome de um gênero personalizado.

gender.type

string

O tipo de gênero.

Valores aceitáveis:
  • female
  • male
  • other
  • unknown

thumbnailPhotoEtag

string

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

ims

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 de IM principal.

Campos

ims[].customProtocol

string

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

ims[].customType

string

Se o IM type for custom, esta propriedade conterá o valor personalizado e deverá ser definida.

ims[].im

string

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

ims[].primary

boolean

Se este for o IM principal do usuário. Só uma entrada na lista de mensagens instantâneas pode ter o valor "true".

ims[].protocol

string

Um protocolo de IM identifica a rede de IM. O valor pode ser uma rede personalizada ou padrão.

Valores aceitáveis:
  • aim: protocolo AOL Instant Messenger
  • custom_protocol: um protocolo de rede IM personalizado
  • gtalk: protocolo Google Talk
  • icq: protocolo ICQ
  • jabber: protocolo Jabber
  • msn: protocolo SharePoint Messenger
  • net_meeting: protocolo Net Meeting
  • qq: protocolo QQ
  • skype: protocolo Skype
  • yahoo: protocolo Yahoo Messenger

ims[].type

string

O tipo de conta de IM. Se definido como custom, customType também precisará ser definido.

Valores aceitáveis: 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 foi aplicada (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 uma barra (/).

recoveryEmail

string

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

recoveryPhone

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.

Nome de usuário

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 todos os usuários em um domínio.

makeAdmin

Transforma um usuário em 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 de dispositivos e redefine os cookies de login.

undelete

Cancela a exclusão de um usuário excluído.

update

Atualiza um usuário.

watch

Monitora alterações na lista de usuários.