创建协议

命名空间:microsoft.graph

创建新的 协议 对象。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ✅

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Agreement.ReadWrite.All 不可用。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 不支持。 不支持。

重要

对于使用工作或学校帐户的委派访问,必须为已登录用户分配受支持的Microsoft Entra角色。 此操作支持以下最低特权角色。

  • 条件访问管理员 - 最低特权
  • 安全管理员

HTTP 请求

POST /identityGovernance/termsOfUse/agreements

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-type application/json. 必需。

请求正文

在请求正文中,提供 协议 对象的 JSON 表示形式。

下表显示了创建协议时所需的属性。

属性 类型 说明
displayName String 协议的显示名称。
isViewingBeforeAcceptanceRequired 布尔值 指示用户在接受协议之前是否必须展开和查看协议。
fileName String 协议文件的名称 (,例如,TOU.pdf) 。
isDefault 布尔值 指示如果语言与客户端首选项匹配,则此文件是否为默认协议文件。 如果未将任何文件标记为默认文件,则第一个文件被视为默认文件。
language String 格式为“languagecode2-country/regioncode2”的协议文件的语言。 “languagecode2”是派生自 ISO 639-1 的小写双字母代码,而“country/regioncode2”派生自 ISO 3166,通常由两个大写字母或 BCP-47 语言标记组成。 例如,美国英语为 en-US。
data Binary 表示 PDF 文档使用条款的数据。

响应

如果成功,此方法在响应正文中返回响应 201, Created 代码和 协议 对象。

示例

请求

在请求正文中,提供 协议 对象的 JSON 表示形式。

POST https://graph.microsoft.com/v1.0/identityGovernance/termsOfUse/agreements
Content-type: application/json

{
  "displayName": "Contoso ToU for guest users",
  "isViewingBeforeAcceptanceRequired": true,
  "files": [
    {
      "fileName": "TOU.pdf",
      "language": "en",
      "isDefault": true,
      "fileData": {
        "data": "SGVsbG8gd29ybGQ=//truncated-binary"
      }
    }
  ]
}

响应

注意:为了提高可读性,可能缩短了此处显示的响应对象。

HTTP/1.1 201 Created
Content-type: application/json

{
  "displayName": "MSGraph Sample",
  "isViewingBeforeAcceptanceRequired": true,
  "id": "093b947f-8363-4979-a47d-4c52b33ee1be"
}