Criar convite
Namespace: microsoft.graph
Use essa API para criar um novo convite. O convite adiciona um usuário externo à organização.
Ao criar um novo convite, você tem várias opções disponíveis:
- Na criação de convites, o Microsoft Graph pode enviar automaticamente um email de convite diretamente para o usuário convidado ou seu aplicativo pode usar o conviteRedeemUrl retornado na resposta para criar seu próprio convite (por meio do mecanismo de comunicação de escolha) para o usuário convidado. Se você decidir fazer com que o Microsoft Graph envie um email de convite automaticamente, você poderá especificar o conteúdo e o idioma do email usando invitedUserMessageInfo.
- Quando o usuário é convidado, uma entidade de usuário (de userType
Guest
) é criada e pode ser usada para controlar o acesso aos recursos. O usuário convidado precisa passar pelo processo de resgate do convite para acessar quaisquer recursos para os quais foi convidado.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
Tipo de permissão | Permissões menos privilegiadas | Permissões privilegiadas mais altas |
---|---|---|
Delegado (conta corporativa ou de estudante) | User.Invite.All | Directory.ReadWrite.All, User.ReadWrite.All |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Application | User.Invite.All | Directory.ReadWrite.All, User.ReadWrite.All |
Importante
As permissões de aplicativo (somente aplicativo) não funcionarão se os convites B2B estiverem desabilitados no locatário ou se os convites B2B estiverem restritos aos administradores.
Solicitação HTTP
POST /invitations
Cabeçalhos de solicitação
Cabeçalho | Valor |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Content-Type | application/json |
Corpo da solicitação
No corpo da solicitação, forneça uma representação JSON do objeto invitation.
A tabela a seguir lista os parâmetros necessários ao criar um convite.
Parâmetro | Tipo | Descrição |
---|---|---|
invitedUserEmailAddress | string | O endereço de email do usuário que você está convidando. |
inviteRedirectUrl | string | A URL para a qual o usuário será redirecionado após o resgate. |
Resposta
Se for bem-sucedido, esse método retornará 201 Created
o código de resposta e um objeto convite no corpo da resposta.
Exemplo
Solicitação
O exemplo a seguir mostra uma solicitação.
POST https://graph.microsoft.com/v1.0/invitations
Content-type: application/json
{
"invitedUserEmailAddress": "admin@fabrikam.com",
"inviteRedirectUrl": "https://myapp.contoso.com"
}
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 201 Created
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#invitations/$entity",
"id": "9071bfde-35e0-47d2-a582-d244ab1b4af6",
"inviteRedeemUrl": "https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3d69997834-fa40-45da-xxxx-382c3bdc66c3%26user%3d9071bfde-35e0-47d2-a582-d244ab1b4af6%26ticket%3dwCFIFW%25252frzl2A%25252fpZFZk5fCLJprpDxtcjR8s%25252fo1QZA0yQ%25253d%26ver%3d2.0",
"invitedUserDisplayName": null,
"invitedUserType": "Guest",
"invitedUserEmailAddress": "admin@fabrikam.com",
"sendInvitationMessage": false,
"resetRedemption": false,
"inviteRedirectUrl": "https://myapp.contoso.com",
"status": "PendingAcceptance",
"invitedUserMessageInfo": {
"messageLanguage": null,
"customizedMessageBody": null,
"ccRecipients": [
{
"emailAddress": {
"name": null,
"address": null
}
}
]
},
"invitedUser": {
"id": "cbb896f9-8306-49d0-b56b-b8e39cd28825"
}
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de