Identity Aware Platform
- Operation Guide
DescribeIAPUserOIDCConfig
Last updated: 2025-04-09 11:40:01
1. API Description
Domain name for API request: iap.intl.tencentcloudapi.com.
This API is used to query a user OIDC configuration.
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: DescribeIAPUserOIDCConfig. |
| Version | Yes | String | Common Params. The value used for this API: 2024-07-13. |
| Region | No | String | Common Params. This parameter is not required. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| ProviderType | Integer | IdP type. 13: IAP user OIDC IdP. |
| IdentityUrl | String | IdP URL. |
| IdentityKey | String | Public key for signature. |
| ClientId | String | Client ID. |
| Status | Integer | Status. 0: Not set; 2: Disabled; 11: Enabled. |
| Fingerprints | Array of String | The verification fingerprint of the HTTPS CA certificate. English letters and digits are allowed, and each fingerprint is 40 characters long, with a maximum of 5 fingerprints. |
| EnableAutoPublicKey | Integer | Whether to enable the automatic use of the OIDC signature public key. 1: Yes, 2: No (default). |
| AuthorizationEndpoint | String | Authorization endpoint. |
| Scope | Array of String | Authorization scope. |
| ResponseType | String | Authorization response type. |
| ResponseMode | String | Authorization response mode. |
| MappingFiled | String | Mapping field name. |
| Description | String | 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 Querying IAP's OIDC Configuration
This example shows you how to query IAP's OIDC configuration.
Input Example
POST / HTTP/1.1
Host: iap.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIAPUserOIDCConfig
<Common request parameters>
{}
Output Example
{
"Response": {
"AuthorizationEndpoint": "https://accounts.g**gle.com/o/oauth2/v2/auth",
"ClientId": "47***01-pu1e*****7tj.apps.g**gleusercontent.com",
"Description": "222",
"IdentityKey": "ewogICAgImtletVUkttZ0I***GTHVVRUJkdyIKICAgICAgICB9CiAgICBdCn0=",
"IdentityUrl": "https://accounts.g**gle.com",
"MappingFiled": "email",
"ProviderType": 13,
"RequestId": "f87e5dab-426a-4a50-ac5b-1c08151cd6a2",
"ResponseMode": "form_post",
"ResponseType": "id_token",
"Scope": [
"openid",
"email",
"profile"
],
"Status": 2
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 | The IdP does not exist. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No