iOA 零信任安全管理系统新建企业目录配置

1. 接口描述

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

创建企业目录配置

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateCompanyDirectoryConfig。
Version	是	String	公共参数，本接口取值：2022-06-01。
Region	否	String	公共参数，本接口不需要传递此参数。
Type	是	String	企业目录类型示例值：MicrosoftEntraID
Name	是	String	企业目录名示例值：AAD配置测试
Config	是	String	配置是通过 SM2 加密再 Hex 之后的数据示例值：{"azure_tenant_id":"目录（租户）ID，必填","client_id":"应用程序(客户端) ID，必填","client_secret":"客户端密码值，必填","cloud_type":"版本类型,必填，可选值为 Global 是国际版, 21Vianet 是中国版"}
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
Description	否	String	描述示例值：目录描述
Scene	否	String	使用场景：API 创建，快速上手，普通配置等示例值：QuickStart

3. 输出参数

参数名称	类型	描述
Data	DirectoryConfigResultData	创建企业目录配置的结果
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建企业目录配置示例

示例是以微软 AAD 配置参考，强烈建议接口调用时，Scene填QuickStart，会自动生成一些兼容配置，Config为JSON 字符串，不同类型配置是不一致的。返回值的Id表示目录Id，非常重要，后续查询编辑都要用到此Id

输入示例

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

{
    "Type": "MicrosoftEntraID",
    "Name": "AAD配置测试",
    "Config": "{\"azure_tenant_id\":\"目录（租户）ID，必填\",\"client_id\":\"应用程序(客户端) ID，必填\",\"client_secret\":\"客户端密码值，必填\",\"cloud_type\":\"版本类型,必填，可选值为 Global 是国际版, 21Vianet 是中国版\"}",
    "SyncEnable": true,
    "SyncPolicy": "",
    "SyncPolicyParams": "",
    "CreateAuthConfig": true,
    "DisplayOnLoginPage": true,
    "Scene": "QuickStart"
}

输出示例

{
    "Response": {
        "Data": {
            "AuthConfigId": 121773,
            "AuthMethods": [
                "SSO认证"
            ],
            "AuthPolicyId": 39217,
            "AuthSourceId": "ioa-union-260092225bqX2szz6RRUDUxaRN5EdoA",
            "AuthSupportPlatforms": [
                "PC"
            ],
            "CreateAuthConfig": true,
            "Id": 278390,
            "IdentifySourceId": "ioa-union-260092225bqX2szz6RRUDUxaRN5EdoA",
            "Name": "AAD配置测试"
        },
        "RequestId": "a7246c21-50d0-4893-bc9e-80f24dc9e916"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.DatabaseQueryFailed	数据库查询失败。
InternalError.DatabaseWriteFailed	数据库写入失败。
InvalidParameter.RequestParam	请求参数错误。
InvalidParameter.SameAccountGroupName	存在同名用户组
LimitExceeded.CompanyDirectoryMaxLimit	可创建目录总数超过了上限

新建企业目录配置

本页目录：