创建邀请
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
创建新 邀请。 邀请将外部用户添加到组织。
以下选项可用于创建邀请:
- 创建邀请时,Microsoft Graph 可以自动向受邀用户发送邀请电子邮件,或者你的应用可以使用响应中返回的 inviteRedeemUrl ,通过所选) 到受邀用户的通信机制来创建自己的邀请 (。 如果你决定让 Microsoft Graph 自动发送邀请电子邮件,则可以使用 invitedUserMessageInfo 指定电子邮件的内容和语言。
- 邀请用户时,将创建 userType
Guest
) 的用户实体 (,可用于控制对资源的访问。 受邀请的用户必须完成兑换过程才能访问其获得访问邀请的任意资源。
此 API 可用于以下国家级云部署。
全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 | 最低特权权限 | 更高特权权限 |
---|---|---|
委派(工作或学校帐户) | User.Invite.All | Directory.ReadWrite.All、User.ReadWrite.All |
委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
应用程序 | User.Invite.All | Directory.ReadWrite.All、User.ReadWrite.All |
重要
如果租户上禁用了 B2B 邀请,或者 B2B 邀请仅限于管理员,则应用程序权限 (仅限应用) 不起作用。
HTTP 请求
POST /invitations
请求标头
标头 | 值 |
---|---|
Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
Content-Type | application/json |
请求正文
在请求正文中,提供 invitation 对象的 JSON 表示形式。
下表列出了创建邀请时所需的参数。
参数 | 类型 | 说明 |
---|---|---|
invitedUserEmailAddress | string | 要邀请的用户的电子邮件地址。 |
inviteRedirectUrl | string | 兑现后用户将被重定向至的 URL。 |
响应
如果成功,此方法将在响应正文中返回 201 Created
响应代码和 invitation 对象。
示例
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/beta/invitations
Content-type: application/json
{
"invitedUserEmailAddress": "admin@fabrikam.com",
"inviteRedirectUrl": "https://myapp.contoso.com"
}
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 201 Created
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$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"
}
}
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈