文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>API 中心>iOA 零信任安全管理系统>身份与权限管理相关接口>编辑企业目录配置

编辑企业目录配置

最近更新时间：2026-05-19 02:04:57

我的收藏

本页目录：

1. 接口描述

接口请求域名： ioa.tencentcloudapi.com 。

编辑企业目录配置

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ModifyCompanyDirectoryConfig。
Version 是 String 公共参数，本接口取值：2022-06-01。
Region 否 String 公共参数，本接口不需要传递此参数。
Type 是 String

企业目录类型


示例值：MicrosoftEntraID
Name 是 String

企业目录名


示例值：AAD配置测试2
Config 是 String

使用 JSON 字符串表示的配置信息

调用此接口前，需要先调用DescribeCompanyDirectoryConfig获取完整的配置，然后对里面需要更新的配置进行修改，请求的时候必须传完整配置，否则可能导致配置缺失出现错误。如果是脱敏的信息，保持原样的脱敏格式提交，如果和脱敏格式不一致，会认为是新的配置值更新原有配置


示例值：{"azure_tenant_id":"目录（租户）ID，必填","client_id":"应用程序(客户端) ID，必填","client_secret":"**","cloud_type":"版本类型,必填，可选值为 Global 是国际版, 21Vianet 是中国版","sensitive_fields":["client_secret"]}
SyncEnable 是 Boolean

是否开启定时同步


示例值：true
SyncPolicy 是 String

定时同步的策略，枚举值：支持每4小时（4hours）/每日定时（daily）/每周定时（weekly）


示例值：4hours
SyncPolicyParams 是 String

JSON 字符串，针对不同类型的同步策略，提取对应不同的值


示例值：{"week":"SAT","hour":"02","minute":"30"}
CreateAuthConfig 是 Boolean

是否同步创建认证源


示例值：true
DisplayOnLoginPage 是 Boolean

是否在登录页展示


示例值：true
Id 否 Integer

企业目录 ID


示例值：278390
Description 否 String

描述


示例值：目录描述

3. 输出参数

参数名称 类型 描述
Data DirectoryConfigResultData

编辑企业目录配置的结果
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 更新目录配置示例

先通过DescribeCompanyDirectoryConfig 获取配置数据后，在修改数据调用此接口请求变更

输入示例

POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyCompanyDirectoryConfig
<公共请求参数>

{
    "Type": "MicrosoftEntraID",
    "Name": "AAD配置测试2",
    "Config": "{\"attribute_map\":{\"avatar\":\"-\",\"email\":\"mail\",\"extended_id\":\"-\",\"name\":\"displayName\",\"phone\":\"mobilePhone\",\"user_id\":\"userPrincipalName\"},\"azure_tenant_id\":\"目录（租户）ID，必填\",\"client_id\":\"应用程序(客户端) ID，必填\",\"client_secret\":\"******\",\"cloud_type\":\"版本类型,必填，可选值为 Global 是国际版, 21Vianet 是中国版\",\"extended_attributes\":[],\"group_ids\":\"\",\"sensitive_fields\":[\"client_secret\"],\"status_attribute\":{\"type\":\"none\"}}",
    "SyncEnable": true,
    "SyncPolicy": "4hours",
    "SyncPolicyParams": "{\"week\":\"SAT\",\"hour\":\"02\",\"minute\":\"30\"}",
    "CreateAuthConfig": true,
    "DisplayOnLoginPage": true,
    "Id": 278390
}

输出示例

{
    "Response": {
        "Data": {
            "AuthConfigId": 0,
            "AuthMethods": [],
            "AuthPolicyId": 0,
            "AuthSourceId": "",
            "AuthSupportPlatforms": [],
            "CreateAuthConfig": true,
            "Id": 278390,
            "IdentifySourceId": "ioa-union-260092225bqX2szz6RRUDUxaRN5EdoA",
            "Name": "AAD配置测试2"
        },
        "RequestId": "91d4f838-654f-4f6e-b265-b012b81b4614"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
InternalError.DatabaseQueryFailed 数据库查询失败。
InternalError.DatabaseWriteFailed 数据库写入失败。
InvalidParameter.RequestParam 请求参数错误。
InvalidParameter.SameAccountGroupName 存在同名用户组
中国站