GetExternalSAMLIdentityProvider

聚焦模式

字号

最后更新时间： 2026-03-20 00:29:03

1. API Description

Domain name for API request: organization.intl.tencentcloudapi.com.

This API is used to query the SAML identity provider configuration information.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: GetExternalSAMLIdentityProvider.
Version	Yes	String	Common Params. The value used for this API: 2021-03-31.
Region	No	String	Common Params. This parameter is not required.
ZoneId	Yes	String	Space ID.

3. Output Parameters

Parameter Name	Type	Description
SAMLIdentityProviderConfiguration	SAMLIdentityProviderConfiguration	SAML identity provider configuration information.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the SAML Identity Provider Configuration Information

This example shows you how to query the SAML identity provider configuration information.

Input Example

POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetExternalSAMLIdentityProvider
<Common request parameters>

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

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.DBOperationError	SQL execution error.
InternalError	An internal error occurred.
ResourceNotFound.SAMLIdentityProviderNotFound	The SAML identity provider configuration does not exist.

帮助和支持

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

填写满意度调查问卷，共创更好文档体验。

文档反馈

tencent cloud

Tencent Cloud Organization