tipo de recurso convite

Artigo
10/18/2023

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 Versão.

Representa um convite que é usado para adicionar usuários externos a uma organização como parte de Microsoft Entra colaboração business-to-business (Microsoft Entra B2B).

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 seleciona no link de convite, entra e resgata 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 retorna uma URL de resgate na resposta (inviteRedeemUrl). A API de convite de criação pode enviar automaticamente um email contendo a URL de resgate para o usuário convidado, definindo o sendInvitationMessage como true. Você também pode personalizar a mensagem enviada ao usuário convidado. Em vez disso, se você quiser enviar a URL de resgate por meio de alguns outros meios, poderá definir o sendInvitationMessage como false e usar a URL de resgate da resposta para criar sua própria comunicação. Atualmente, não há API para executar o processo de resgate. O usuário convidado precisa selecionar o link inviteRedeemUrl enviado na comunicação na etapa acima e passar pelo processo interativo de resgate em um navegador. Depois de concluído, o usuário convidado se torna um usuário externo na organização.

Observação

O convite status é acompanhado usando as propriedades externalUserState eexternalUserStateChangeDateTime 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	O usuário de URL deve ser redirecionado quando o convite for resgatado. Obrigatório.
inviteRedeemUrl	Cadeia de caracteres	O URL que o usuário pode usar para resgatar o convite dele. Somente leitura.
invitedUserType	String	O userType do usuário que está sendo convidado. Por padrão, é `Guest` Você pode convidar como `Member` se fosse um administrador da empresa. O padrão é `false`.
resetRedemption	Booliano	Redefina o resgate do usuário status e reinvite um usuário, mantendo seu identificador de usuário, associações de grupo e atribuições de aplicativo. Essa propriedade permite permitir que um usuário entre usando um endereço de email diferente do do convite anterior. Para obter mais informações sobre como usar essa propriedade, consulte Redefinir status de resgate para um usuário convidado (Versão prévia).
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. Read-Only
invitedUserSponsors	Coleção directoryObject	Os usuários ou grupos que são patrocinadores do usuário convidado. Os patrocinadores são usuários e grupos responsáveis pelos privilégios dos usuários convidados no locatário e por manter as informações e o acesso dos usuários convidados atualizados.

Representação JSON

A representação JSON a seguir mostra o tipo de 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"
}

Compartilhar via