tipo de recurso conviteinvitation resource type

Namespace: microsoft.graphNamespace: microsoft.graph

Representa um convite usado para adicionar usuários externos a uma organização.Represents an invitation that is used to add external users to an organization.

O processo de convite usa o fluxo a seguir:The invitation process uses the following flow:

  • Um convite é criadoAn invitation is created
  • Um convite é enviado ao usuário convidado (contendo um link do convite)An invitation is sent to the invited user (containing an invitation link)
  • 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ídaThe invited user clicks on the invitation link, signs in and redeems the invitation and creation of the user entity representing the invited user completes
  • O usuário é redirecionado para uma página específica após a conclusão do resgateThe user is redirected to a specific page after redemption completes

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.Creating an invitation will return a redemption URL in the response (inviteRedeemUrl). The create invitation API can automatically send an email containing the redemption URL to the invited user, by setting the sendInvitationMessage to true. You can also customize the message that will be sent to the invited user. Instead, if you wish to send the redemption URL through some other means, you can set the sendInvitationMessage to false and use the redeem URL from the response to craft your own communication. Currently, there is no API to perform the redemption process. The invited user has to click on the inviteRedeemUrl link sent in the communication in the step above, and go through the interactive redemption process in a browser. Once completed, the invited user becomes an external user in the organization.

MétodosMethods

MétodoMethod Tipo de retornoReturn Type DescriçãoDescription
Criar conviteCreate invitation invitationinvitation Escreva as propriedades e os relacionamentos do objeto invitation.Write properties and relationships of invitation object.

PropriedadesProperties

PropriedadeProperty TipoType DescriçãoDescription
invitedUserDisplayNameinvitedUserDisplayName StringString O nome de exibição do usuário que está sendo convidado.The display name of the user being invited.
invitedUserEmailAddressinvitedUserEmailAddress StringString O endereço de email do usuário que está sendo convidado.The email address of the user being invited. Obrigatório.Required. Os seguintes caracteres especiais não são permitidos no endereço de email:The following special characters are not permitted in the email address:
  • Til (~)Tilde (~)
  • Ponto de exclamação (!)Exclamation point (!)
  • Hashtag (#)Number sign (#)
  • Cifrão ($)Dollar sign ($)
  • Percentagem (%)Percent (%)
  • Acento circunflexo (^)Circumflex (^)
  • E comercial (&)Ampersand (&)
  • Asterisco (*)Asterisk (*)
  • Parênteses (( ))Parentheses (( ))
  • Sinal de mais (+)Plus sign (+)
  • Sinal de igualdade (=)Equal sign (=)
  • Colchetes ([ ])Brackets ([ ])
  • Chaves ({ })Braces ({ })
  • Barra invertida (\)Backslash (\)
  • Barra (/)Slash mark (/)
  • Barra vertical (\|)Pipe (\|)
  • Ponto e vírgula (;)Semicolon (;)
  • Dois pontos (:)Colon (:)
  • Aspas (")Quotation marks (")
  • Sinais de maior-que e menor-que(< >)Angle brackets (< >)
  • Sinal de interrogação (?)Question mark (?)
  • Vírgula (,)Comma (,)

No entanto, as seguintes exceções se aplicam:However, the following exceptions apply:
  • Um ponto (.) ou um hífen (-) é permitido em qualquer lugar no nome de usuário, exceto no início ou no final do nome.A period (.) or a hyphen (-) is permitted anywhere in the user name, except at the beginning or end of the name.
  • Um underline (_) é permitido em qualquer lugar no nome de usuário.An underscore (_) is permitted anywhere in the user name. Isso inclui no início ou no final do nome.This includes at the beginning or end of the name.
invitedUserMessageInfoinvitedUserMessageInfo invitedUserMessageInfoinvitedUserMessageInfo 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.Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.
sendInvitationMessagesendInvitationMessage BooleanBoolean Indica se um email deve ser enviado ao usuário que está sendo convidado ou não. O padrão é false.Indicates whether an email should be sent to the user being invited or not. The default is false.
inviteRedirectUrlinviteRedirectUrl Cadeia de caracteresString O URL para a qual o usuário deve ser redirecionado uma vez que o convite seja resgatado. Obrigatório.The URL the user should be redirected to once the invitation is redeemed. Required.
inviteRedeemUrlinviteRedeemUrl Cadeia de caracteresString O URL que o usuário pode usar para resgatar seus convites. Somente leituraThe URL the user can use to redeem their invitation. Read-only ..
invitedUserTypeinvitedUserType StringString O userType do usuário que está sendo convidado.The userType of the user being invited. Por padrão, é Convidado.By default, this is Guest. Você poderá convidar como Membro se não for administrador da empresa.You can invite as Member if you are a company administrator.
statusstatus StringString O status do convite. Valores possíveis: PendingAcceptance, Completed, InProgress, e ErrorThe status of the invitation. Possible values: PendingAcceptance, Completed, InProgress, and Error

RelaçõesRelationships

RelaçãoRelationship TipoType DescriçãoDescription
invitedUserinvitedUser UserUser O usuário criado como parte da criação do convite. Somente leituraThe user created as part of the invitation creation. Read-Only

Representação JSONJSON representation

Veja a seguir uma representação JSON do recursoHere is a JSON representation of the resource

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