tipo de recurso convite

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor de versão.

Representa um convite usado para adicionar usuários externos a uma organização.

O processo de convite usa o fluxo a seguir:

• Um convite é criado
• Um convite é enviado ao usuário convidado (contendo um link do convite)
• O usuário convidado clica no link do convite, entra e recupera o convite, e a criação da entidade de usuário que representa o usuário convidado é concluída
• O usuário é redirecionado para uma página específica após a conclusão do resgate

A criação de um convite retornará uma URL de resgate na resposta (inviteRedeemUrl). A API de criação de convite pode enviar automaticamente um email que contém a URL de resgate ao usuário convidado, definindo-se sendInvitationMessage como true. Você também pode personalizar a mensagem será enviada ao usuário convidado. Em vez disso, se você desejar enviar a URL de resgate por outros meios, poderá definir sendInvitationMessage como false e usar a URL de resgate da resposta para criar sua própria comunicação. Atualmente, não há qualquer API para execução do processo de resgate. O usuário convidado tem que clicar no link inviteRedeemUrl enviado na comunicação na etapa anterior e passar pelo processo de resgate interativo em um navegador. Após a conclusão, o usuário convidado torna-se um usuário externo na organização.

Observação

O status do convite é rastreado usando as propriedades externalUserState e externalUserStateChangeDateTime no recurso de usuário externo criado como parte da solicitação de convite.

Métodos

Método	Tipo de retorno	Descrição
Criar convite	invitation	Escreva as propriedades e os relacionamentos do objeto invitation.

Propriedades

Propriedade	Tipo	Descrição
invitedUserDisplayName	String	O nome de exibição do usuário que está sendo convidado.
invitedUserEmailAddress	String	O endereço de email do usuário que está sendo convidado. Obrigatório. Os seguintes caracteres especiais não são permitidos no endereço de email: Til (~) Ponto de exclamação (!) Arroba (@) Hashtag (#) Cifrão ($) Percentagem (%) Acento circunflexo (^) E comercial (&) Asterisco (*) Parênteses (( )) Hífen (-) Sinal de mais (+) Sinal de igualdade (=) Colchetes ([ ]) Chaves ({ }) Barra invertida (\) Barra (/) Barra vertical (|) Ponto e vírgula (;) Dois pontos (:) Aspas (") Sinais de maior-que e menor-que(< >) Sinal de interrogação (?) Vírgula (,) No entanto, as seguintes exceções se aplicam: Um ponto (.) ou um hífen (-) é permitido em qualquer lugar no nome de usuário, exceto no início ou no final do nome. Um underline (_) é permitido em qualquer lugar no nome de usuário. Isso inclui no início ou no final do nome.
invitedUserMessageInfo	invitedUserMessageInfo	Configurações adicionais para a mensagem que está sendo enviada ao usuário convidado, incluindo a lista de destinatários cc, o idioma e o texto da mensagem de personalização.
inviteRedirectUrl	String	A URL para a qual o usuário deve ser redirecionado após o resgate do convite. Obrigatório.
inviteRedeemUrl	Cadeia de caracteres	O URL que o usuário pode usar para resgatar seu convite. Somente leitura.
invitedUserType	String	O userType do usuário que está sendo convidado. Por padrão, é Guest Você pode convidar Member como se fosse administrador da empresa. O padrão é false.
resetRedemption	Boolean	Reset the user's redemption status and reinvite a user while retaining their user identifier, group memberships, and app assignments. Essa propriedade permite que você habilita um usuário a entrar usando um endereço de email diferente do do convite anterior. Para obter mais informações sobre como usar essa propriedade, consulte Reset redemption status for a guest user (Preview).
sendInvitationMessage	Boolean	Indica se um email deve ser enviado ao usuário que está sendo convidado. O padrão é false.
status	Cadeia de caracteres	O status do convite. Valores possíveis: PendingAcceptance Completed , , InProgress e Error

Relações

Relação	Tipo	Descrição
invitedUser	user	O usuário criado como parte da criação do convite. Somente leitura

Representação JSON

Veja a seguir uma representação JSON do recurso

{
  "id": "String",
  "invitedUserDisplayName": "String",
  "invitedUserEmailAddress": "String",
  "invitedUserMessageInfo": {"@odata.type": "microsoft.graph.invitedUserMessageInfo"},
  "sendInvitationMessage": false,
  "inviteRedirectUrl": "String",
  "inviteRedeemUrl": "String",
  "resetRedemption": false,
  "status": "String",
  "invitedUser": {"@odata.type": "microsoft.graph.user"},
  "invitedUserType": "String"
}