Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Visão geral da API User Invitation
A API Cloud Identity User Invitation permite identificar e gerenciar
contas não gerenciadas como parte dos usuários de integração no seu domínio do Google Workspace ou
Cloud Identity.
As contas não gerenciadas são definidas pelos seguintes critérios:
o endereço de e-mail é uma conta pessoal e o endereço de e-mail principal
da conta;
O domínio do endereço de e-mail corresponde a um domínio verificado
do Google Workspace ou do Cloud Identity.
Essas contas geralmente existem porque um dos usuários do cliente se inscreveu
nos serviços do Google para consumidores usando o endereço de e-mail educacional ou de trabalho.
Quando o cliente se inscreve no Google Workspace ou no Cloud Identity
e provisiona uma conta de usuário com o mesmo endereço de e-mail principal de uma
conta não gerenciada atual, essa conta não gerenciada entra em conflito e
precisa ser resolvida.
A API User Invitation torna as principais tarefas de resolução automatizáveis:
Determinar se um determinado endereço de e-mail está qualificado para participar do domínio do
cliente (precisa atender a ambos os critérios)
Enviar convites de e-mail ad hoc ou em lote para endereços de e-mail qualificados para que eles
participem do domínio do cliente
Recuperar uma lista de contas não gerenciadas, filtráveis pelo estado
do convite. Todas as contas não gerenciadas no domínio do cliente são tratadas
como convites de usuário não enviados (state==NOT_YET_SENT) até que sejam enviadas.
Procurar um convite específico por endereço de e-mail
Cancelar convites já enviados
O fluxo de convite permite que o usuário final e o administrador
garantam que todos os dados criados com a conta pessoal sejam gerenciados pela
entidade correta:
Se o usuário final tiver dados relacionados aos negócios na conta pessoal e
aceitar o convite, o administrador poderá assumir a propriedade e gerenciar
os dados de acordo com as políticas do cliente.
Se os dados do usuário final não forem relacionados ao negócio e ele recusar, o
convite avisará ao usuário que pode ser necessário renomear o endereço de e-mail
posteriormente se o administrador criar uma nova Conta do Google para ele. O
administrador pode criar uma nova conta gerenciada e remover o endereço de e-mail
principal da conta pessoal, criando o conflito. O usuário final precisará
renomear o endereço de e-mail para outro endereço sempre que
ele fizer login na Conta do Google pessoal.
Para entender como a resolução de conflitos de contas funciona no Admin Console,
leia
Encontrar e gerenciar contas
na Central de Ajuda do Google Admin.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-09-04 UTC."],[[["\u003cp\u003eThe Cloud Identity User Invitation API helps manage unmanaged accounts during user onboarding to Google Workspace or Cloud Identity domains.\u003c/p\u003e\n"],["\u003cp\u003eUnmanaged accounts are consumer accounts whose email domain matches a verified Google Workspace or Cloud Identity domain, created because users signed up for consumer Google services with their work or school email.\u003c/p\u003e\n"],["\u003cp\u003eThis API automates key resolution tasks, like determining eligibility, sending invitations, listing unmanaged accounts, looking up specific invitations, and canceling sent invitations.\u003c/p\u003e\n"],["\u003cp\u003eThe user invitation process allows administrators to take ownership of business-related data from consumer accounts or inform users to rename their email if it's personal.\u003c/p\u003e\n"],["\u003cp\u003eThe API can be set up by following the steps in \u003ca href=\"/identity/docs/how-to/setup-user-invitations\"\u003eSetting up the User Invitation API\u003c/a\u003e, and more information on conflict resolution can be found in the Google Admin Help Center under \u003ca href=\"https://support.google.com/a/answer/6178640\"\u003eFind and manage existing accounts\u003c/a\u003e.\u003c/p\u003e\n"]]],[],null,["# User Invitation API overview\n============================\n\nThe Cloud Identity User Invitation API allows you to identify and manage\nunmanaged accounts as part of onboarding users to your Google Workspace or\nCloud Identity domain.\n|\n| **Beta**\n|\n|\n| This product is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA products are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nUnmanaged accounts are defined by the following criteria:\n\n- the email address is a consumer account and it's the primary email address of the account, and\n- the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain\n\nThese accounts generally exist because one of the customer's users has signed\nup for consumer Google services using their work or educational email address.\nWhen the customer then signs up for Google Workspace or Cloud Identity\nand provisions a user account with the same primary email address as an\nexisting unmanaged account, that unmanaged account becomes conflicted and\nneeds to be resolved.\n\nThe User Invitation API makes key resolution tasks automatable:\n\n- Determine if a given email address is eligible to join the customer's domain (must meet both criteria)\n- Send ad-hoc or batch email invitations to eligible email addresses so they can join the customer's domain\n- Retrieve a list of unmanaged accounts, filterable by their invitation state. All unmanaged accounts on the customer's domain are treated as unsent user invitations (`state==NOT_YET_SENT`) until they are sent.\n- Look up a specific invitation by email address\n- Cancel already-sent invitations\n\nThe user invitation flow allows both the end user and the administrator to\nensure that any data created using the consumer account is managed by the\ncorrect entity:\n\n- If the end user has business-related data under the consumer account and accepts the invitation, the administrator can take ownership and manage the data according to the customer's policies.\n- If the end user's data is not business-related and they decline, the invitation gives the user notice that they may need to rename the email address later if the admin creates a new Google account for them. The administrator can create a new managed account and evict the primary email address of the consumer account, creating the conflict. The end user will then be asked to rename their email address to another email address every time they log in to their personal Google account.\n\nNext steps\n----------\n\nHere are a few next steps you might take:\n\n- To set up the API, refer to [Setting up the User Invitation API](/identity/docs/how-to/setup-user-invitations).\n- To understand how account conflict resolution works in the Admin Console, read [Find and manage existing accounts](https://support.google.com/a/answer/6178640) in the Google Admin Help Center."]]
