tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeOIDCConfig

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

1. API Description

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

This API is used to query role OIDC configurations.

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: DescribeOIDCConfig.
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 Name.

3. Output Parameters

Parameter Name Type Description
ProviderType Integer IdP type. 11: Role IdP.
IdentityUrl String IdP URL.
IdentityKey String Public key for signature.
ClientId Array of String Client ID.
Status Integer Status. 0: Not set; 2: Disabled; 11: Enabled.
Description String Description.
Name String Name.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting role OIDC configurations

Input Example

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

{
    "Name": "Name"
}

Output Example

{
    "Response": {
        "Description": "Desc",
        "ProviderType": 11,
        "IdentityUrl": "https://*****.qq.cn/",
        "IdentityKey": "ewogICAgImtleXMiOiBbCiAgICAg********jenYyT0kiCiAgICAgICAgfQogICAgXQp9",
        "ClientId": [
            "61adcf0******bc9546"
        ],
        "Name": "Name",
        "Status": 11,
        "RequestId": "24366174-63dd-42ba-8073-bd6b0af0f241"
    }
}

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
InvalidParameter Incorrect parameter.
InvalidParameterValue.NameError Identity provider name error.
ResourceNotFound.IdentityNotExist Identity provider does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy