tipo de recurso convite

Namespace: microsoft.graph

Representa um convite que é utilizado para adicionar utilizadores externos a uma organização como parte da colaboração empresa-empresa (B2B) no ID externa do Microsoft Entra.

O processo de convite usa o fluxo a seguir:

• É criado um convite.
• Um convite que contém uma ligação de convite é enviado para o utilizador convidado.
• O utilizador convidado seleciona a ligação de convite, inicia sessão e resgata o convite e a entidade de utilizador que representa o utilizador convidado é criada.
• O utilizador é redirecionado para uma página específica após a conclusão do resgate.

A criação de um convite devolve um URL de resgate na resposta (inviteRedeemUrl). A API de criação de convite pode enviar automaticamente um e-mail que contém o URL de resgate para o utilizador convidado, ao definir sendInvitationMessage como true. Também pode personalizar a mensagem que é enviada ao utilizador convidado. Em vez disso, se quiser enviar o URL de resgate através de outros meios, pode definir sendInvitationMessage como false e utilizar o URL de resgate da resposta para criar a sua própria comunicação. Atualmente, não está disponível nenhuma API para realizar o processo de resgate. O utilizador convidado tem de selecionar a ligação inviteRedeemUrl enviada na comunicação e percorrer o processo de resgate interativo num browser. Quando o processo estiver concluído, o utilizador convidado torna-se um utilizador externo na organização.

Métodos

Método	Tipo de retorno	Descrição
Criar	invitation	Criar um objeto de convite.

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 carateres especiais não são permitidos no endereço de e-mail: Til (~) Ponto de exclamação (!) Hashtag (#) Cifrão ($) Percentagem (%) Acento circunflexo (^) E comercial (&) Asterisco (*) Parênteses (( )) 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. É permitido um caráter de sublinhado (_) em qualquer parte do nome de utilizador, incluindo no início ou no fim do nome.
invitedUserMessageInfo	invitedUserMessageInfo	Contém a configuração da mensagem que está a ser enviada para o utilizador convidado, incluindo personalizar o texto da mensagem, o idioma e a lista de destinatários cc.
invitedUserType	String	O userType do usuário que está sendo convidado. Por padrão, é Guest Pode convidar como Member se fosse um administrador da empresa.
inviteRedirectUrl	Cadeia de caracteres	O URL para o qual o utilizador deve ser redirecionado após o convite ser resgatado. Obrigatório.
inviteRedeemUrl	Cadeia de caracteres	O URL que o usuário pode usar para resgatar o convite dele. Somente leitura.
resetRedemption	Booliano	Reponha o resgate do utilizador status e volte a convidar um utilizador ao manter o identificador de utilizador, as associações a grupos e as atribuições de aplicações. Esta propriedade permite-lhe permitir que um utilizador inicie sessão com um endereço de e-mail diferente do do convite anterior. Quando true, a relação deIDinvitedUser/ é necessária. Para obter mais informações sobre como utilizar esta propriedade, veja Repor status de resgate de um utilizador convidado.
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. Os valores possíveis são: PendingAcceptance, Completed, InProgress, e Error.

Relações

Relação	Tipo	Descrição
invitedUser	user	O utilizador criou como parte da criação do convite. Somente leitura. A propriedade ID é necessária no corpo do pedido para repor um status de resgate.
invitedUserSponsors	Coleção directoryObject	Os utilizadores ou grupos que são patrocinadores do utilizador convidado. Os patrocinadores são utilizadores e grupos responsáveis pelos privilégios dos utilizadores convidados no inquilino e por manter as informações e o acesso dos utilizadores convidados atualizados.

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
  "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"
}