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

Representa um convite usado para adicionar usuários externos a uma organização como parte da colaboração B2B (entre empresas) na ID Externa do Microsoft ID Entra.

O processo de convite usa o fluxo a seguir:

  • Um convite é criado.
  • Um convite que contém um link de convite é enviado ao usuário convidado.
  • O usuário convidado seleciona o link de convite, entra e resgata o convite, e a entidade de usuário que representa o usuário convidado é criada.
  • 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 criação de convite pode enviar automaticamente um email que contém a URL de resgate para o usuário convidado, definindo sendInvitationMessage como true. Você também pode personalizar a mensagem enviada ao usuário convidado. Em vez disso, se quiser enviar a URL de resgate por outros meios, você poderá definir sendInvitationMessage e false usar a URL de resgate da resposta para criar sua própria comunicação. Atualmente, nenhuma API está disponível para executar o processo de resgate. O usuário convidado deve selecionar o link inviteRedeemUrl enviado na comunicação e passar pelo processo de resgate interativo em um navegador. Quando o processo é concluído, o usuário convidado se torna 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 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 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 sublinhado (_) é permitido em qualquer parte do nome de usuário, inclusive no começo ou no final do nome.
invitedUserMessageInfo invitedUserMessageInfo Contém informações de configuração para a mensagem que está sendo enviada ao usuário convidado, incluindo a personalização do texto da mensagem, idioma e lista de destinatários cc.
inviteRedirectUrl String O usuário da URL deve ser redirecionado assim que 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 status de resgate do usuário e convide novamente um usuário, mantendo seu identificador de usuário, associações de grupo e atribuições de aplicativo. Esta propriedade permite que você permita a entrada de um usuário usando um endereço de email diferente daquele no convite anterior. Quando true, a relação deIDinvitedUser/ é necessária. Para obter mais informações sobre como usar essa propriedade, consulte Redefinir o status de resgate para um usuário 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. Valores possíveis: PendingAcceptance, Completed, InProgresse Error

Relações

Relação Tipo Descrição
invitedUser user O usuário criado como parte da criação do convite. Somente Leitura. A propriedade id é necessária no corpo da solicitação para redefinir um status de resgate.
invitedUserSponsors Coleção directoryObject Os usuários ou grupos que são patrocinadores do usuário convidado. 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"
}
  • Última atualização a