创建协议

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

创建新的 协议 对象。

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

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

权限

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

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

在具有工作或学校帐户的委派方案中,登录用户必须是组的所有者或成员,或者分配有受支持的 Microsoft Entra 角色 或具有支持的角色权限的自定义角色。 安全管理员条件访问管理员 是此操作支持的最低特权角色。

HTTP 请求

POST /identityGovernance/termsOfUse/agreements

请求标头

名称 类型 说明
Authorization string 持有者 {token}。 必填。

请求正文

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

下表显示创建用户时所需的属性。

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

响应

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

示例

请求

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

POST https://graph.microsoft.com/beta/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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#agreements/$entity",
    "id": "94410bbf-3d3e-4683-8149-f034e55c39dd",
    "displayName": "Contoso ToU for guest users",
    "termsExpiration": null,
    "userReacceptRequiredFrequency": null,
    "isViewingBeforeAcceptanceRequired": true,
    "isPerDeviceAcceptanceRequired": false
}