Como criar e gerenciar convites de usuários

Nesta página, você verá como realizar algumas operações fundamentais com a API Cloud Identity User Invitation.

Antes de começar

Observação: antes de usar qualquer uma das APIs do Cloud Identity, configure o Cloud Identity. Consulte Como configurar o Cloud Identity para ver instruções.

Execute as seguintes tarefas antes de continuar com as informações desta página:

• Leia a Visão geral da API User Invitation.
• Configure a API User Invitation.

Como determinar a qualificação para o convite

Conforme descrito na visão geral, para ser convidado, uma conta de usuário precisa atender a vários critérios. Você pode usar o método IsInvitableUser() para descobrir se uma determinada conta de usuário está qualificada.

REST

Para verificar a qualificação de uma conta de usuário, chame customers.userinvitations.isInvitableUser() com o ID de cliente e o endereço de e-mail da conta.

Exemplo de solicitação

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:isInvitableUser

Como recuperar convites do usuário

A API User Invitation fornece métodos para recuperar um único convite de usuário e recuperar todos eles. Ao recuperar todos os convites de usuários, você tem a opção de filtrá-los por estado e definir a ordem de classificação.

Como recuperar um convite de usuário único

REST

Para recuperar um único convite do usuário, chame customers.userinvitations.get() com o ID de cliente e o endereço de e-mail da conta.

Exemplo de solicitação

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]

Como recuperar uma lista de convites do usuário

Todos os usuários não gerenciados são exibidos automaticamente como convites no estado NOT_YET_SENT até que o administrador ou o usuário final faça isso. Depois que um convite é aceito pelo usuário, a conta não é mais considerada não gerenciada.

• Se você chamar customers.userinvitations.list() com o estado na solicitação, ele retornará apenas os usuários com convite nesse estado.
• Se você chamar customers.userinvitations.list() sem o estado na solicitação, todos os convites de usuário serão retornados.

É possível verificar vários estados adicionando um operador or ao filtro: state=='accepted'||state=='declined'

REST

Para recuperar uma lista de convites de usuários, chame customers.userinvitations.list() com o ID de cliente e todos os parâmetros de consulta que você quiser para filtrar, ordenar e paginar os resultados. O exemplo a seguir retorna uma lista de todos os usuários não gerenciados, ordenados pelo horário da última atualização em ordem decrescente.

Exemplo de solicitação

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations?filter=state!='accepted'&orderBy='updateTime desc'

Como enviar convites do usuário

Os convites não são enviados automaticamente aos usuários qualificados. Quando tiver uma lista de usuários que você quer convidar, use o método customers.userinvitations.send(). Isso também criará um convite se ele não existir.

REST

Para enviar um e-mail de convite a um usuário, chame customers.userinvitations.send() com o ID de cliente e o endereço de e-mail da conta de usuário.

Exemplo de solicitação

POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:send

Cancelar convites de usuários

Os convites dos usuários podem ser cancelados até serem aceitos ou recusados. Chame o método customers.userinvitations.cancel() para cancelar um convite.

REST

Para cancelar um convite de usuário, chame customers.userinvitations.cancel() com o ID de cliente e o endereço de e-mail da conta de usuário.

Exemplo de solicitação

POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:cancel