查询SAML身份提供商配置信息

最近更新时间:2024-08-14 02:14:53

我的收藏

1. 接口描述

接口请求域名: organization.tencentcloudapi.com 。

查询SAML身份提供商配置信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetExternalSAMLIdentityProvider。
Version String 公共参数,本接口取值:2021-03-31。
Region String 公共参数,此参数为可选参数。
ZoneId String 空间ID。
示例值:z-2js923necd***

3. 输出参数

参数名称 类型 描述
SAMLIdentityProviderConfiguration SAMLIdentityProviderConfiguration saml 身份提供商配置信息。
示例值:{"EntityId":"http://www.okta.com/2jd83ne9m*****","SSOStatus":"Enabled","EncodedMetadataDocument":"PD94bWwgdmVyc2lvbj0iMS4wIj8+CjxFbnRpdHlEZXNjcmlwdG9yIHhtbG5zPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoydpbi5jb20vc2FtbC9tZXRhZGF0YS8xN2NkYjEyOC03N**********","CertificateIds":["idp-c-2jd8923je29****"],"LoginUrl":"https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/2jd83ne9m****/sso/saml","CreateTime":"2024-01-01 12:12:12","UpdateTime":"2024-01-01 12:12:12"}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询SAML身份提供商配置信息

查询SAML身份提供商配置信息

输入示例

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

{
    "ZoneId": "z-dm239d****"
}

输出示例

{
    "Response": {
        "SAMLIdentityProviderConfiguration": {
            "EntityId": "http://www.okta.com/2jd83ne9m*****",
            "SSOStatus": "Enabled",
            "EncodedMetadataDocument": "PD94bWwgdmVyc2lvbj0iMS4wIj8+CjxFbnRpdHlEZXNjcmlwdG9yIHhtbG5zPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoydpbi5jb20vc2FtbC9tZXRhZGF0YS8xN2NkYjEyOC03N**********",
            "CertificateIds": [
                "idp-c-2jd8923je29****"
            ],
            "LoginUrl": "https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/2jd83ne9m****/sso/saml",
            "CreateTime": "2024-01-01 12:12:12",
            "UpdateTime": "2024-01-01 12:12:12"
        },
        "RequestId": "2ccd7ed1-24b4-4882-8f4a-5580b430bce7"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DBOperationError SQL执行报错
InternalError 内部错误。
ResourceNotFound.SAMLIdentityProviderNotFound saml 身份提供商配置不存在。