获取企业目录配置

1. 接口描述

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

获取企业目录配置

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 获取企业目录配置详情

Config为目录生成后的完整配置，敏感字段会被直接脱敏返回

输入示例

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

{
    "Id": 278390
}

输出示例

{
    "Response": {
        "Data": {
            "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\"}}",
            "CreateAuthConfig": true,
            "Description": "",
            "DisplayOnLoginPage": true,
            "Id": 278390,
            "Name": "AAD配置测试",
            "SourceId": "ioa-union-260092225bqX2szz6RRUDUxaRN5EdoA",
            "SyncEnable": true,
            "SyncPolicy": "4hours",
            "SyncPolicyParams": "{\"week\":\"SAT\",\"hour\":\"02\",\"minute\":\"30\"}",
            "Type": "MicrosoftEntraID"
        },
        "RequestId": "ed8ce64f-ecd5-46b4-a47c-9bdc394e3db3"
    }
}

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. 错误码

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