Gerenciar contas do usuário

A API Directory oferece métodos programáticos para criar, atualizar e excluir usuários. Também é possível receber informações sobre usuários individuais ou listas de usuários que atendem a critérios específicos. Confira a seguir exemplos de algumas operações básicas do usuário.

Criar uma conta de usuário

Você pode adicionar uma conta de usuário a qualquer um dos domínios da sua conta do Google Workspace. Antes de adicionar uma conta de usuário, confirme a propriedade do domínio.

Se você tiver atualizado sua conta pessoal do Gmail para uma conta de e-mail comercial com seu próprio nome de domínio, não será possível criar novas contas de usuário até que você desbloqueie outras configurações do Google Workspace. Para saber mais, consulte As contas de e-mail comercial do G Suite foram atualizadas para o G Suite Basic.

Para criar uma conta de usuário usando um dos seus domínios, use a solicitação POST abaixo e inclua a autorização descrita em Saiba mais sobre autenticação e autorização. Confira os escopos disponíveis para a API Directory na lista de escopos do OAuth 2.0. Para as propriedades da string de consulta da solicitação, consulte o método users.insert(). 

POST https://admin.googleapis.com/admin/directory/v1/users

Todas as solicitações de criação exigem que você envie as informações necessárias para atender à solicitação. Se você estiver usando bibliotecas de cliente, elas vão converter os objetos de dados do idioma escolhido em objetos formatados por dados JSON.

Solicitação JSON

O JSON a seguir mostra um exemplo de solicitação para criar um usuário. Para uma lista completa de propriedades de solicitação e resposta, consulte a Referência da API. 

{
"primaryEmail": "[email protected]",
"name": {
 "givenName": "Elizabeth",
 "familyName": "Smith"
},
"suspended": false,
"password": "new user password",
"hashFunction": "SHA-1",
"changePasswordAtNextLogin": false,
"ipWhitelisted": false,
"ims": [
 {
  "type": "work",
  "protocol": "gtalk",
  "im": "[email protected]",
  "primary": true
 }
],
"emails": [
 {
  "address": "[email protected]",
  "type": "home",
  "customType": "",
  "primary": true
 }
],
"addresses": [
 {
  "type": "work",
  "customType": "",
  "streetAddress": "1600 Amphitheatre Parkway",
  "locality": "Mountain View",
  "region": "CA",
  "postalCode": "94043"
 }
],
"externalIds": [
 {
  "value": "12345",
  "type": "custom",
  "customType": "employee"
 }
],
"organizations": [
 {
  "name": "Google Inc.",
  "title": "SWE",
  "primary": true,
  "type": "work",
  "description": "Software engineer"
 }
],
"phones": [
 {
  "value": "+1 nnn nnn nnnn",
  "type": "work"
 }
],
"orgUnitPath": "/corp/engineering",
"includeInGlobalAddressList": true
}

Se a taxa de consulta para solicitações de criação for muito alta, você poderá receber respostas HTTP 503 do servidor da API indicando que a cota foi excedida. Se você receber essas respostas, use um algoritmo de espera exponencial para tentar novamente.

Informações importantes sobre uma nova conta:

  • Se a conta do Google tiver comprado licenças de e-mail, uma caixa de entrada será atribuída automaticamente à nova conta de usuário. Essa atividade pode levar alguns minutos para ser concluída e ativada.
  • A edição de um campo somente leitura em uma solicitação, como isAdmin, é ignorada pelo serviço da API.
  • O número máximo de domínios permitidos em uma conta é 600 (1 domínio principal + 599 domínios adicionais)
  • Se um usuário não foi atribuído a uma unidade organizacional específica quando a conta foi criada, a conta está na unidade organizacional de nível superior. A unidade organizacional de um usuário determina quais serviços do Google Workspace ele tem acesso. Se o usuário for movido para uma nova organização, o acesso dele vai mudar. Para mais informações sobre estruturas de organização, consulte a Central de Ajuda para administradores. Para mais informações sobre como mover um usuário para uma organização diferente, consulte Atualizar um usuário.
  • Um password é necessário para novas contas de usuário. Se um hashFunction for especificado, a senha precisará ser uma chave de hash válida. Se não for especificado, a senha precisa estar em texto simples e ter entre 8 e 100 caracteres ASCII. Para saber mais, consulte a Referência da API.
  • Para usuários em um plano flexível do Google Workspace, a criação de usuários usando essa API vai ter impacto financeiro e resultar em cobranças na sua conta de faturamento do cliente. Para mais informações, consulte as informações de faturamento da API.
  • Uma conta do Google Workspace pode incluir qualquer um dos seus domínios. Em uma conta de vários domínios, os usuários de um domínio podem compartilhar serviços com usuários de outros domínios da conta. Para mais informações sobre usuários em vários domínios, consulte as informações sobre vários domínios da API.
  • Pode haver contas conflitantes. Confira se a pessoa que você quer adicionar já tem uma Conta do Google. Depois siga as etapas para evitar conflitos com essas contas. Consulte Encontrar e resolver contas conflitantes.
  • Pode haver contas de visitante. Se os usuários convidarem pessoas de fora da sua organização que não têm Contas do Google para colaborar no Drive, elas vão receber contas de visitante no formato "nome_de_usuário_do_visitante@seu_domínio.com". Se você adicionar um usuário com o mesmo nome de usuário de uma conta de visitante, ela será convertida em uma conta completa do Google Workspace. A conta vai manter as permissões dos arquivos do Drive. Consulte Compartilhar documentos com visitantes.

Uma resposta bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta retorna as propriedades da nova conta de usuário.

Atualizar uma conta de usuário

Para atualizar uma conta de usuário, use a seguinte solicitação PUT e inclua a autorização descrita em Autorizar solicitações. O userKey pode ser o endereço de e-mail principal do usuário, o id exclusivo do usuário ou um dos endereços de e-mail de alias do usuário.

PUT https://admin.googleapis.com/admin/directory/v1/users/userKey

O corpo da solicitação e da resposta contém uma instância de User. No entanto, a API Directory oferece suporte à semântica de patch. Portanto, basta enviar os campos atualizados na solicitação.

Exemplo de solicitação

No exemplo abaixo, o givenName do usuário era "Elizabeth" quando a conta foi criada, e apenas um endereço de e-mail de trabalho foi fornecido.

{
  "name": {
    "givenName": "Elizabeth",
    "familyName": "Smith"
   },
  "emails": [
    {
      "address": "[email protected]",
      "type": "work",
      "primary": true
    }
}

A solicitação abaixo atualiza givenName de "Elizabeth" para "Liz" e também adiciona um endereço de e-mail residencial. Observe que ambos os endereços de e-mail são fornecidos completamente porque o campo é uma matriz.

PUT https://admin.googleapis.com/admin/directory/v1/users/[email protected]

{
  "name": {
    "givenName": "Liz",
   },
  "emails": [
    {
      "address": "[email protected]",
      "type": "work",
      "primary": true
    },
    {
      "address": "[email protected]",
      "type": "home"
    }
  ]
}

Uma resposta bem-sucedida retorna um código de status HTTP 200 e um recurso User com os campos atualizados.

Tenha em mente o seguinte ao atualizar o nome da conta de um usuário:

  • Renomear uma conta de usuário muda o endereço de e-mail principal e o domínio usado ao recuperar as informações do usuário. Antes de renomear um usuário, recomendamos que você saia de todas as sessões e serviços do navegador.
  • O processo de renomear uma conta de usuário pode levar até 10 minutos para ser propagado em todos os serviços.
  • Quando você renomeia um usuário, o nome antigo é mantido como um alias para garantir a entrega contínua de e-mails no caso de configurações de encaminhamento de e-mail e não está disponível como um novo nome de usuário.
  • Em geral, também recomendamos não usar o endereço de e-mail do usuário como chave para dados persistentes, porque ele está sujeito a mudanças.
  • Para conferir uma lista completa dos efeitos da alteração do nome de um usuário nos apps do Google Workspace, acesse a Central de Ajuda para administradores.

Tornar um usuário administrador

Para tornar o usuário um superadministrador, use a seguinte solicitação POST e inclua a autorização descrita em Autorizar solicitações. O userKey pode ser o endereço de e-mail principal do usuário, o id exclusivo do usuário ou um dos endereços de e-mail de alias do usuário. Para as propriedades de solicitação e resposta, consulte a Referência da API. Para mais informações sobre um superadministrador, consulte a Central de Ajuda de administração. 

POST https://admin.googleapis.com/admin/directory/v1/users/userKey/makeAdmin

Solicitação JSON

Neste exemplo, o usuário com userKey [email protected] se tornou um superadministrador: 

POST https://admin.googleapis.com/admin/directory/v1/users/[email protected]/makeAdmin

{
 "status": true
}

Uma resposta bem-sucedida retorna um código de status HTTP 200.

Gerenciar relacionamentos de usuários

A API Directory usa o campo relations para definir diferentes tipos de relações entre usuários. Em um ambiente comercial, as pessoas geralmente usam esse campo para relações de gerente-funcionário e assistente, mas o campo também oferece suporte a muitos outros tipos. A relação aparece no card "Pessoas relacionadas" do usuário em qualquer aplicativo do Google Workspace compatível. Para conferir exemplos de onde o card fica visível, consulte Adicionar informações ao perfil de um usuário no diretório.

Criar uma relação entre usuários

É possível definir uma relação em apenas uma direção, começando pelo usuário "proprietário", cujo registro inclui o campo relations. O type descreve a relação da outra pessoa com o usuário proprietário. Por exemplo, em uma relação de gerente e funcionário, o funcionário é o usuário proprietário e você adiciona um campo relations à conta dele com o tipo manager. Para tipos permitidos, consulte a referência do objeto User.

Configure a relação criando ou atualizado o usuário proprietário com um corpo de solicitação JSON que inclua o campo relations. É possível criar várias relações em uma solicitação.

{
  "relations": [
    {
      "value": "EMAIL_ADDRESS_RELATION_1",
      "type": "manager"
    },
    {
      "value": "EMAIL_ADDRESS_RELATION_2",
      "type": "dotted_line_manager"
    }
  ]
}

Atualizar ou excluir uma relação

O campo relations só pode ser atualizado como um todo. Não é possível direcionar as pessoas listadas para mudar o tipo de relacionamento ou remover. No exemplo acima, para remover a relação de administrador existente e tornar o administrador de linha pontilhada o administrador do usuário proprietário, atualize a conta do usuário proprietário com todos os valores do campo conforme desejado.

{
  "relations": [
    {
      "value": "EMAIL_ADDRESS_RELATION_2",
      "type": "manager"
    }
  ]
}

Para remover todas as relações do usuário proprietário, deixe relations em branco:

{
  "relations": []
}

Recuperar um usuário

Para recuperar um usuário, use a seguinte solicitação GET e inclua a autorização descrita em Autorizar solicitações. O userKey pode ser o endereço de e-mail principal do usuário, o id exclusivo do usuário ou um dos endereços de e-mail de alias do usuário. Para as propriedades de solicitação e resposta, consulte a Referência da API. 

GET https://admin.googleapis.com/admin/directory/v1/users/userKey

Este exemplo retorna as propriedades da conta do usuário cujo endereço de e-mail principal ou alias é [email protected]: 

GET https://admin.googleapis.com/admin/directory/v1/users/[email protected]

Resposta JSON

Uma resposta bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta retorna as propriedades da conta de usuário. 

{
 "kind": "directory#user",
 "id": "the unique user id",
 "primaryEmail": "[email protected]",
 "name": {
  "givenName": "Liz",
  "familyName": "Smith",
  "fullName": "Liz Smith"
 },
 "isAdmin": true,
 "isDelegatedAdmin": false,
 "lastLoginTime": "2013-02-05T10:30:03.325Z",
 "creationTime": "2010-04-05T17:30:04.325Z",
 "agreedToTerms": true,
 "hashFunction": "SHA-1",
 "suspended": false,
 "changePasswordAtNextLogin": false,
 "ipWhitelisted": false,
 "ims": [
  {
   "type": "work",
   "protocol": "gtalk",
   "im": "[email protected]",
   "primary": true
  }
 ],
 "emails": [
  {
   "address": "[email protected]",
   "type": "home",
   "customType": "",
   "primary": true
  }
 ],
 "addresses": [
  {
   "type": "work",
   "customType": "",
   "streetAddress": "1600 Amphitheatre Parkway",
   "locality": "Mountain View",
   "region": "CA",
   "postalCode": "94043"
  }
 ],
 "externalIds": [
  {
   "value": "employee number",
   "type": "custom",
   "customType": "office"
  }
 ],
 "organizations": [
  {
   "name": "Google Inc.",
   "title": "SWE",
   "primary": true,
   "customType": "",
   "description": "Software engineer"
  }
 ],
 "phones": [
  {
   "value": "+1 nnn nnn nnnn",
   "type": "work"
  }
 ],
 "aliases": [
  "[email protected]",
  "[email protected]"
 ],
 "nonEditableAliases": [
  "[email protected]"
 ],
 "customerId": "C03az79cb",
 "orgUnitPath": "corp/engineering",
 "isMailboxSetup": true,
 "includeInGlobalAddressList": true
}

Extrair todos os usuários de um domínio

Para recuperar todos os usuários no mesmo domínio, use a seguinte solicitação GET e inclua a autorização descrita em Autorizar solicitações. Para facilitar a leitura, este exemplo usa retornos de linha: 

GET https://admin.googleapis.com/admin/directory/v1/users
?domain=primary domain name&pageToken=token for next results page
&maxResults=max number of results per page
&orderBy=email, givenName, or familyName
&sortOrder=ascending or descending
&query=email, givenName, or familyName:the query's value*

Para as propriedades de solicitação e resposta, consulte a Referência da API.

Resposta JSON

Neste exemplo, todos os usuários no domínio example.com são retornados com um máximo de dois domínios de usuário por página de resposta. Há um nextPageToken para a lista de usuários de acompanhamento nesta resposta. Por padrão, o sistema retorna uma lista de 100 usuários na ordem alfabética do endereço de e-mail do usuário: 

GET https://admin.googleapis.com/admin/directory/v1/users?domain=example.com&maxResults=2

Uma resposta bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta retorna duas contas de usuário no domínio example.com (maxResults=2): 

{
 "kind": "directory#users",
 "users": [
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "primaryEmail": "[email protected]",
   "name": {
    "givenName": "Liz",
    "familyName": "Smith",
    "fullName": "Liz Smith"
   },
   "isAdmin": true,
   "isDelegatedAdmin": false,
   "lastLoginTime": "2013-02-05T10:30:03.325Z",
   "creationTime": "2010-04-05T17:30:04.325Z",
   "agreedToTerms": true,
   "hashFunction": "SHA-1",
   "suspended": false,
   "changePasswordAtNextLogin": false,
   "ipWhitelisted": false,
   "ims": [
    {
     "type": "work",
     "protocol": "gtalk",
     "im": "[email protected]",
     "primary": true
    }
   ],
   "emails": [
    {
     "address": "[email protected]",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "addresses": [
    {
     "type": "work",
     "customType": "",
     "streetAddress": "1600 Amphitheatre Parkway",
     "locality": "Mountain View",
     "region": "CA",
     "postalCode": "94043"
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "office"
    }
   ],
   "organizations": [
    {
     "name": "Google Inc.",
     "title": "SWE",
     "primary": true,
     "customType": "",
     "description": "Software engineer"
    }
   ],
   "phones": [
    {
     "value": "+1 nnn nnn nnnn",
     "type": "work"
    }
   ],
   "aliases": [
    "[email protected]",
    "[email protected]"
   ],
   "nonEditableAliases": [
    "[email protected]"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "corp/engineering",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  },
  {
   "kind": "directory#user",
   "id": "user unique ID",
   "primaryEmail": "[email protected]",
   "name": {
    "givenName": "admin",
    "familyName": "two",
    "fullName": "admin two"
   },
   "isAdmin": true,
   "isDelegatedAdmin": true,
   "lastLoginTime": "2013-02-05T10:30:03.325Z",
   "creationTime": "2010-04-05T17:30:04.325Z",
   "agreedToTerms": true,
   "hashFunction": "SHA-1",
   "suspended": true,
   "suspensionReason": "ADMIN",
   "changePasswordAtNextLogin": false,
   "ipWhitelisted": false,
   "emails": [
    {
     "address": "[email protected]",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "contractor license number",
     "type": "custom",
     "customType": "work"
    }
   ],
   "aliases": [
    "[email protected]"
   ],
   "nonEditableAliases": [
    "[email protected]"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "corp/engineering",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  }
 ],
 "nextPageToken": "next page token"
}

Extrair todos os usuários da conta

Para recuperar todos os usuários de uma conta que pode consistir em vários domínios, use a seguinte solicitação GET e inclua a autorização descrita em Autorizar solicitações. Para facilitar a leitura, este exemplo usa retornos de linha: 

GET https://admin.googleapis.com/admin/directory/v1/users
?customer=my_customer or customerId&pageToken=token for next results page
&maxResults=max number of results per page
&orderBy=email, givenName, or familyName
&sortOrder=ascending or descending
&query=user attributes
  • A string de consulta customer é o valor my_customer ou customerId.
  • Use a string my_customer para representar o customerId da sua conta.
  • Como administrador de revendedor, use o customerId do cliente revendido. Para o customerId, use o nome de domínio principal da conta na solicitação da operação Recuperar todos os usuários em um domínio. A resposta resultante tem o valor customerId.
  • A string de consulta orderBy opcional determina se a lista é classificada pelo endereço de e-mail principal, pelo sobrenome ou pelo nome do usuário. Ao usar orderBy, você também pode usar a string de consulta sortOrder para listar os resultados em ordem crescente ou decrescente.
  • A string de consulta query opcional permite pesquisar em muitos campos no perfil de um usuário, incluindo campos principais e personalizados. Consulte Pesquisar usuários para conferir exemplos.

Para as propriedades de solicitação e resposta, consulte a Referência da API.

Neste exemplo, um administrador da conta está solicitando que todos os usuários na conta sejam retornados com uma entrada de usuário em cada página de resposta. O nextPageToken vai para a página de resultados seguinte: 

GET https://admin.googleapis.com/admin/directory/v1/users?customer=my_customer&maxResults=1

Neste exemplo, um administrador de revendedor está solicitando todos os usuários em uma conta revendida que tem o valor customerId de C03az79cb. 

GET https://admin.googleapis.com/admin/directory/v1/users?customer=C03az79cb&maxResults=1

Resposta JSON

Uma resposta bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta retorna todos os usuários dessa conta: 

{
 "kind": "directory#users",
 "users": [
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "username": "[email protected]",
   "name": {
    "givenName": "admin",
    "familyName": "two",
    "fullName": "admin two"
   },
   "isAdmin": true,
   "isDelegatedAdmin": true,
   "lastLoginTime": "2013-02-05T10:30:03.325Z",
   "creationTime": "2010-04-05T17:30:04.325Z",
   "agreedToTerms": true,
   "hashFunction": "SHA-1",
   "suspended": false,
   "changePasswordAtNextLogin": false,
   "ipWhitelisted": false,
   "emails": [
    {
     "address": "[email protected]",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "office"
    }
   ],
   "aliases": [
     "[email protected]"
   ],
   "nonEditableAliases": [
     "[email protected]"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "/",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  },
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "username": "[email protected]",
   "name": {
    "givenName": "Elizabeth",
    "familyName": "Smith",
    "fullName": "Elizabeth Smith"
   },
   "isAdmin": false,
   "isDelegatedAdmin": false,
   "lastLoginTime": "1336509883546",
   "creationTime": "1404802800000",
   "agreedToTerms": false,
   "hashFunction": "SHA-1",
   "suspended": false,
   "changePasswordAtNextLogin": false,
   "ipWhitelisted": false,
   "emails": [
    {
     "address": "[email protected]",
     "type": "home",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "bank"
    }
   ],
   "relations": [
    {
     "value": "liz",
     "type": "friend",
     "customType": ""
    }
   ],
   "aliases": [
    "[email protected]",
    "[email protected]"
   ],
   "nonEditableAliases": [
    "[email protected]"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "/",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  },
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "username": "[email protected]",
   "name": {
    "givenName": "Tester",
    "familyName": "Three",
    "fullName": "Tester Three"
   },
   "isAdmin": false,
   "isDelegatedAdmin": false,
   "lastLoginTime": "1336509883546",
   "creationTime": "1404802800000",
   "agreedToTerms": true,
   "hashFunction": "SHA-1",
   "suspended": false,
   "changePasswordAtNextLogin": false,
   "ipWhitelisted": false,
   "emails": [
    {
     "address": "[email protected]",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "office"
    }
   ],
   "aliases": [
    "[email protected]"
   ],
   "nonEditableAliases": [
    "[email protected]"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "/",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  },
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "username": "[email protected]",
   "name": {
    "givenName": "Admin",
    "familyName": "Work",
    "fullName": "Admin Work"
   },
   "isAdmin": true,
   "isDelegatedAdmin": true,
   "lastLoginTime": "1336509883546",
   "creationTime": "1404802800000",
   "agreedToTerms": true,
   "hashFunction": "SHA-1",
   "suspended": false,
   "changePasswordAtNextLogin": false,
   "ipWhitelisted": false,
   "emails": [
    {
     "address": "[email protected]",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "office"
    }
   ],
   "aliases": [
    "[email protected]"
   ],
   "nonEditableAliases": [
    "[email protected]"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "/",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  }
 ],
 "nextPageToken": "NNNNN"
}

Recuperar usuários excluídos recentemente

Para recuperar todos os usuários excluídos nos últimos 20 dias de uma conta ou de um dos domínios dela, use as solicitações GET abaixo e inclua a autorização descrita em Autorizar solicitações. Para cancelar a exclusão de um usuário, consulte Cancelar a exclusão de um usuário.

Para recuperar usuários excluídos nos últimos 20 dias do domínio principal da conta ou de um subdomínio, use a seguinte solicitação GET. A string de consulta domain é o nome de domínio principal do domínio. Para as propriedades de solicitação e resposta do usuário, consulte a Referência da API. Para facilitar a leitura, este exemplo usa retornos de linha: 

GET https://admin.googleapis.com/admin/directory/v1/users
?domain=primary domain name&pageToken=token for next results page
&maxResults=max number of results per page
&showDeleted=true
 Se uma conta tiver vários domínios, você poderá recuperar os usuários excluídos nos últimos 20 dias de toda a conta. Para isso, use a seguinte solicitação GET. Para facilitar a leitura, este exemplo usa retornos de linha: 
GET https://admin.googleapis.com/admin/directory/v1/users
?customer=my_customer or customerId&pageToken=token for next results page
&maxResults=max number of results per page&showDeleted=true
  • A string de consulta customer é o valor my_customer ou customerId.
  • Como administrador da conta, use a string my_customer para representar o customerId da sua conta.
  • Como administrador de revendedor, use o customerId do cliente revendido. Para o customerId, use o nome de domínio principal da conta na solicitação da operação Recuperar todos os usuários em um domínio. A resposta resultante tem o valor customerId.

Para as propriedades de solicitação e resposta, consulte a Referência da API.

Neste exemplo, um administrador da conta está solicitando todos os usuários excluídos: 

GET https://admin.googleapis.com/admin/directory/v1/users?customer=my_customer&showDeleted=true

Resposta JSON

Uma resposta bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta retorna todos os usuários da conta excluídos nos últimos 20 dias: 

{
 "kind": "directory#users",
 "users": [
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "primaryEmail": "[email protected]"
  },
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "primaryEmail": "[email protected]"
  }
 ],
 "nextPageToken": "token for next page of deleted users"
}

Extrair a foto de um usuário

A API recupera uma miniatura de foto, a foto do perfil mais recente do Google. Para recuperar a foto mais recente do usuário, use a seguinte solicitação GET e inclua a autorização descrita em Autorizar solicitações. O userKey pode ser o endereço de e-mail principal do usuário, o id ou qualquer um dos e-mails de alias do usuário. Para as propriedades de solicitação e resposta, consulte a Referência da API. 

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/photos/thumbnail

Neste exemplo, a foto mais recente de [email protected] é retornada:

GET https://admin.googleapis.com/admin/directory/v1/users/[email protected]/photos/thumbnail

Resposta JSON

Uma resposta bem-sucedida retorna um código de status HTTP 200. 

{
 "kind": "directory#user#photo",
 "id": "the unique user id",
 "primaryEmail": "[email protected]",
 "mimeType": "the photo mime type",
 "height": "the photo height in pixels",
 "width": "the photo width in pixels",
 "photoData": "web safe base64 encoded photo data"
}

A codificação Base64 segura para Web das suas fotos é semelhante à RFC 4648 "base64url". Isso significa que:

  • O caractere barra (/) é substituído pelo caractere sublinhado (_).
  • O sinal de adição (+) é substituído pelo caractere hífen (-).
  • O caractere de sinal de igual (=) é substituído pelo asterisco (*).
  • Para o preenchimento, o caractere ponto (.) é usado em vez da definição de baseURL RFC-4648, que usa o sinal de igual (=) para o preenchimento. Isso é feito para simplificar a análise de URL.
  • Seja qual for o tamanho da foto que está sendo enviada, a API vai redimensioná-la proporcionalmente para 96 x 96 pixels.

Se você precisar criar links compatíveis com JavaScript, a Biblioteca Closure do Google inclui funções de codificação e decodificação Base64 lançadas sob a licença Apache.

Recuperar um usuário como não administrador

Embora as contas de usuário só possam ser modificadas por administradores, qualquer usuário no domínio pode ler os perfis de usuário. Um usuário que não é administrador pode fazer uma solicitação users.get ou users.list com o parâmetro viewType igual a domain_public para recuperar o perfil público de um usuário. O escopo https://www.googleapis.com/auth/admin.directory.user.readonly é ideal para esse caso de uso.

A visualização domain_public permite que um usuário que não é administrador acesse um conjunto padrão de campos principais. Para um campo personalizado, você pode escolher se ele será público ou privado ao definir o esquema.

Atualizar a foto de um usuário

Para atualizar a foto de um usuário, use a solicitação PUT abaixo e inclua a autorização descrita em Autorizar solicitações. O userKey pode ser o endereço de e-mail principal do usuário, o id do usuário ou qualquer um dos e-mails de alias do usuário. Para as propriedades de solicitação e resposta, consulte a Referência da API. 

PUT https://admin.googleapis.com/admin/directory/v1/users/userKey/photos/thumbnail

Neste exemplo, a foto de [email protected] é atualizada: 

PUT https://admin.googleapis.com/admin/directory/v1/users/[email protected]/photos/thumbnail
 
{
"photoData": "web safe base64 encoded photo data"
}

Ao atualizar uma foto, a height e a width são ignoradas pela API.

Resposta JSON

Uma resposta bem-sucedida retorna um código de status HTTP 200. 

{
 "kind": "directory#user#photo",
 "id": "the unique user id",
 "primaryEmail": "[email protected]",
 "mimeType": "the photo mime type",
 "height": "the photo height in pixels",
 "width": "the photo width in pixels",
 "photoData": "web safe base64 encoded photo data"
}

Excluir a foto de um usuário

Para excluir a foto de um usuário, use a solicitação DELETE abaixo e inclua a autorização descrita em Autorizar solicitações. O userKey pode ser o endereço de e-mail principal do usuário, o id do usuário ou qualquer um dos e-mails de alias do usuário. Para as propriedades de solicitação e resposta, consulte a Referência da API. 

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/photos/thumbnail

Depois de excluída, a foto do usuário não é mostrada. Sempre que a foto de um usuário for necessária, uma silhueta será mostrada.

Excluir uma conta de usuário

Para excluir uma conta de usuário, use a solicitação DELETE abaixo e inclua a autorização descrita em Autorizar solicitações. O userKey pode ser o endereço de e-mail principal do usuário, o id exclusivo do usuário ou um dos endereços de e-mail de alias do usuário. Para as propriedades de solicitação e resposta, consulte a Referência da API. 

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey

Neste exemplo, a conta de usuário [email protected] é excluída: 

DELETE https://admin.googleapis.com/admin/directory/v1/users/[email protected]

Uma resposta bem-sucedida retorna apenas um código de status HTTP 200.

Considerações importantes antes de excluir um usuário:

Cancelar a exclusão de uma conta de usuário

Um usuário excluído nos últimos 20 dias precisa atender a determinadas condições para que a conta possa ser restaurada.

Para restaurar uma conta de usuário, use a seguinte solicitação POST e inclua a autorização descrita em Autorizar solicitações. O userKey é o id do usuário único encontrado na resposta da operação Recuperar usuários excluídos nos últimos 20 dias. O endereço de e-mail principal do usuário ou um dos endereços de e-mail de alias não pode ser usado no userKey para essa operação. Para as propriedades de solicitação e resposta, consulte a Referência da API. 

POST https://admin.googleapis.com/admin/directory/v1/users/userKey/undelete

Neste exemplo, o usuário [email protected] não é excluído. Todas as propriedades da conta anterior desse usuário são restauradas: 

POST https://admin.googleapis.com/admin/directory/v1/users/12309329403209438205/undelete

Uma resposta bem-sucedida retorna apenas um código de status HTTP 204. Para conferir a conta do usuário que não foi excluída, use a operação Recuperar um usuário.