Criar e gerir convites de utilizadores
Esta página explica como realizar algumas operações fundamentais com a API Cloud Identity User Invitation.
Antes de começar
Nota: antes de usar qualquer uma das APIs Cloud Identity, tem de configurar o Cloud Identity. Consulte o artigo Configurar o Cloud ID para obter instruções.
Realize as seguintes tarefas antes de continuar com as informações nesta página:
- Leia a vista geral da API User Invitation.
- Configure a API User Invitation.
Determinar a elegibilidade para convites
Conforme indicado na vista geral,
para ser convidada, uma conta de utilizador tem de cumprir vários critérios. Pode usar o método
IsInvitableUser()
para saber se uma determinada conta de utilizador é elegível.
REST
Para verificar a elegibilidade de uma conta de utilizador, chame
customers.userinvitations.isInvitableUser()
com o ID de cliente e o endereço de email da conta.
Pedido de amostra
GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com:isInvitableUser
A obter convites de utilizadores
A API User Invitation oferece métodos para obter um único convite de utilizador e obter todos os convites. Ao obter todos os convites de utilizadores, pode filtrá-los opcionalmente por estado e definir a ordem de ordenação.
Obter um único convite de utilizador
REST
Para obter um convite de utilizador único, chame o método
customers.userinvitations.get()
com o ID de cliente e o endereço de email da conta.
Pedido de amostra
GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com
Obter uma lista de convites de utilizadores
Todos os utilizadores não geridos aparecem automaticamente como convites no estado NOT_YET_SENT
até que o administrador ou o utilizador final tome uma ação. Quando um utilizador aceita um convite, a conta deixa de ser considerada não gerida.
- Se chamar
customers.userinvitations.list()com o estado no pedido, devolve apenas os utilizadores cujo convite se encontra nesse estado. - Se chamar
customers.userinvitations.list()sem o estado no pedido, são devolvidos todos os convites de utilizadores.
Pode verificar vários estados adicionando um operador or no filtro:
state=='accepted'||state=='declined'
REST
Para obter uma lista de convites de utilizadores, chame o método
customers.userinvitations.list()
com o ID de cliente e quaisquer parâmetros de consulta desejados para filtrar, ordenar e
paginar os resultados. O exemplo seguinte devolve uma lista de todos os utilizadores não geridos, ordenada pela hora de atualização mais recente por ordem descendente.
Pedido de amostra
GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations?filter=state!='accepted'&orderBy='updateTime desc'
Envio de convites de utilizadores
Os convites de utilizadores não são enviados automaticamente aos utilizadores elegíveis. Quando tiver uma lista dos utilizadores que quer convidar, pode usar o método customers.userinvitations.send().
Esta ação também cria um convite se não existir.
REST
Para enviar um email de convite a um utilizador, chame o método
customers.userinvitations.send()
com o ID de cliente e o endereço de email da conta de utilizador.
Pedido de amostra
POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com:send
Cancelar convites de utilizadores
Os convites de utilizadores podem ser cancelados até serem aceites ou recusados. Chame o método customers.userinvitations.cancel() para cancelar um convite.
REST
Para cancelar um convite de utilizador, chame customers.userinvitations.cancel() com o ID de cliente e o endereço de email da conta de utilizador.
Pedido de amostra
POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com:cancel