tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

GetSAMLProvider

Last updated: 2023-03-15 10:25:11

1. API Description

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

This API is used to query SAML identity provider details.

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: GetSAMLProvider.
Version Yes String Common Params. The value used for this API: 2019-01-16.
Region No String Common Params. This parameter is not required for this API.
Name Yes String SAML identity provider name

3. Output Parameters

Parameter Name Type Description
Name String SAML identity provider name
Description String SAML identity provider description
CreateTime Timestamp Time SAML identity provider created
ModifyTime Timestamp Time SAML identity provider last modified
SAMLMetadata String SAML identity provider metadata document
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying identity provider details

This example shows you how to query identity provider details.

Input Example

https://cam.tencentcloudapi.com/?Action=GetSAMLProvider
&Name=okta
&<Common request parameters>

Output Example

{
    "Response": {
        "Name": "okta",
        "Description": "okta",
        "CreateTime": "2018-09-17 17:18:03",
        "ModifyTime": "2018-09-17 17:18:03",
        "SAMLMetadata": "U0FNTE1ldGFkYXRh",
        "RequestId": "fea0ebe5-3062-4b5a-b95e-8cce5a3b0512"
    }
}

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
ResourceNotFound.IdentityNotExist Identity provider does not exist.
ResourceNotFound.NotFound Resource does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy