Updated on 2026-07-22 GMT+08:00

Querying All OIDC Providers

Function

This interface is used to query the IdP list of all OpenID Connect (OIDC).

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

iam:oidcProviders:listV5

List

oidcProvider *

-

-

-

URI

GET /v5/oidc-providers

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition:

Number of records displayed per page.

Constraints:

N/A

Range:

The value ranges from 1 to 200.

Default Value:

The default value is 100.

marker

No

String

Definition:

Pagination marker automatically generated by the service to mark the start position of this request. The value can be obtained from next_marker in the response body of the previous pagination request.

Constraints:

The value contains 4 to 400 characters. Only letters, digits, plus signs (+), slashes (/), equal signs (=), hyphens (-), and underscores (_) are allowed.

Range:

N/A

Default Value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

oidc_providers

Array of oidc_providers objects

Definition

List of OIDC providers.

Range

N/A

page_info

page_info object

Definition

Pagination information.

Range

N/A

Table 3 oidc_providers

Parameter

Type

Description

provider_id

String

Definition

ID of an OIDC identity provider.

Range

The value must contain 1 to 64 characters, including only letters, digits, and hyphens (-).

name

String

Definition

Name of an OIDC identity provider.

Range

The value must contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

description

String

Definition

Description of an identity provider.

Range

The value can contain a maximum of 255 characters and cannot contain the following special characters: @#%&<>$^*.

url

String

Definition

URL of an OIDC identity provider.

Range

The value can contain 1 to 255 characters.

urn

String

Definition

Uniform resource name.

Range

The value can contain 16 to 1,500 characters, including only letters, digits, and the following special characters: /=_:-.

client_ids

Array of strings

Definition

A list of client IDs.

Range

The array contains 1 to 100 elements. Each element contains 1 to 255 characters.

thumbprints

Array of strings

Definition

List of server certificate fingerprints of an OIDC identity provider.

Range

The array contains 1 to 5 elements. Each element contains 64 characters, including letters and digits.

created_at

String

Definition

Time when a provider was created.

Range

N/A

Table 4 page_info

Parameter

Type

Description

next_marker

String

Definition

If this parameter is returned, there are subsequent items that are not displayed in the current response body. Use this value as the pagination marker for the next request to obtain information in the next page. Call this API repeatedly until this field is not returned.

Range

N/A

current_count

Integer

Definition

Number of records returned on this page.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition :

Error code. For details, see Error Code.

Range:

The format is PAP5.XXXX, for example, PAP5.0012.

error_msg

String

Definition :

Error message. For details, see Error Message.

Range:

N/A.

request_id

String

Definition:

Unique identifier of an API request, which is used to locate API calling exceptions.

Range:

N/A

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition :

Error code. For details, see Error Code.

Range:

The format is PAP5.XXXX, for example, PAP5.0012.

error_msg

String

Definition :

Error message. For details, see Error Message.

Range:

N/A.

request_id

String

Definition:

Unique identifier of an API request, which is used to locate API calling exceptions.

Range:

N/A

encoded_authorization_message

String

Definition :

Encrypted details returned when the authentication fails, which are used to locate authentication problems. The STS5 decryption API can be used for decryption. For details, see API link.

Range:

N/A.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "oidc_providers" : [ {
    "provider_id" : "string",
    "name" : "string",
    "url" : "string",
    "urn" : "iam::accountid:user:name",
    "client_ids" : [ "string", "string" ],
    "thumbprints" : [ "stringstringstringstringstringstringstringstringstringstringstri", "stringstringstringstringstringstringstringstringstringstringstri" ],
    "created_at" : "2026-06-22T12:00:18.982Z",
    "description" : null
  } ],
  "page_info" : {
    "current_count" : 1
  }
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Abnormal request body.

403

No operation permissions.

Error Codes

See Error Codes.