Como criar e gerenciar convites do usuário

Nesta página, explicamos como executar algumas operações básicas com a API Cloud Identity User Invitation.

Antes de começar

Observação: antes de usar qualquer uma das APIs do Cloud Identity, é preciso configurar 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:

Como determinar a qualificação do convite

Conforme observado na visão geral, para ser convidado, uma conta de usuário precisa atender a vários critérios. Use 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 do cliente e o endereço de e-mail da conta.

Exemplo de solicitação

GET https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com:isInvitableUser

Como recuperar convites dos usuários

A API User Invites fornece métodos para recuperar um único convite de usuário e recuperar todos eles. Ao recuperar todos os convites de usuário, é possível filtrá-los por estado e definir a ordem de classificação.

Como recuperar um único convite de usuário

REST

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

Exemplo de solicitação

GET https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com

Como recuperar uma lista de convites do usuário

Todos os usuários não gerenciados aparecem automaticamente como convites no estado NOT_YET_SENT até que sejam conduzidos pelo administrador ou pelo usuário final. Quando um convite é aceito pelo usuário, a conta não é mais considerada não gerenciada.

É possível verificar vários estados adicionando um operador or no 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 os parâmetros de consulta desejados para filtrar, ordenar e paginar os resultados. O exemplo a seguir retorna uma lista de todos os usuários não gerenciados, ordenados pelo último horário atualizado em ordem decrescente.

Exemplo de solicitação

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

Como enviar convites do usuário

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

REST

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

Exemplo de solicitação

POST https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com:send

Como cancelar convites do usuário

Os convites de 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 do cliente e o endereço de e-mail da conta de usuário.

Exemplo de solicitação

POST https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com:cancel