tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

SetExternalSAMLIdentityProvider

最后更新时间：2024-08-26 11:25:19

1. API Description

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

This API is used to configure the SAML identity provider 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: SetExternalSAMLIdentityProvider.
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.
EncodedMetadataDocument No String IdP metadata document (Base64 encoded). Provided by an IdP that supports the SAML 2.0 protocol.
SSOStatus No String SSO enabling status. Valid values: Enabled, Disabled (default).
EntityId No String IdP identifier.
LoginUrl No String IdP login URL.
X509Certificate No String X509 certificate in PEM format. If this parameter is specified, all existing certificates will be replaced.

3. Output Parameters

Parameter Name Type Description
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 Configuring the SAML Identity Provider Information

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

Input Example

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

{
    "ZoneId": "z-d3ideodm***",
    "EncodedMetadataDocument": "JTNDJTNGeG1sJTIwdmVyc2lvbiUzRCUyMjEuMCUyMiUyMGVuY29kaW5******",
    "SSOStatus": "Enabled",
    "EntityId": "http://www.okta.com/xd83nd83nd****",
    "LoginUrl": "https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/xd83nd83nd****/sso/saml",
    "X509Certificate": "MIIC8DCCAdigAwIBAgIQP9eomUYGeoND****"
}

Output Example

{
    "Response": {
        "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

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.
FailedOperation.DecodeMetadataDocumentFailed Metadata document decoding failed.
FailedOperation.MetadataCosParsingFailed IdP metadata parsing failed.
FailedOperation.SAMLServiceProviderCreateFailed SAML service provider creation failed.
FailedOperation.UploadMetadataFailed Data file uploading failed.
FailedOperation.X509CertificateParsingFailed X509 certificate parsing failed.
FailedOperation.XMLDataUnmarshalFailed XML parsing for the metadata document failed.
InternalError An internal error occurred.
InvalidParameterValue.SSoStatusInvalid The SSO enabling status is invalid.
InvalidParameterValue.X509CertificateFormatError The X509 certificate has a format error.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款