Help Center/ Identity and Access Management_Identity and Access Management (New Edition)/ API Reference/ API/ IAM/ OIDC Identity Provider Management/ Removing a Specified Client ID from a Specified OIDC Provider
Updated on 2026-07-22 GMT+08:00
View PDF
Share

Removing a Specified Client ID from a Specified OIDC Provider

Function

This API is used to remove a specified client ID from the client ID list of an IAM OIDC provider.

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:removeClientIdV5

Write

oidcProvider *

g:ResourceTag/<tag-key>

-

-

URI

POST /v5/oidc-providers/{provider_id}/remove-client-id

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

provider_id

Yes

String

Definition

Provider ID.

Constraints

N/A

Range

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

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

client_id

Yes

String

Definition

Client ID to be removed from the OIDC provider.

Constraints

Length range: 1 to 255.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Request succeeded.

Status code: 400

Table 3 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 4 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.

Status code: 404

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: 409

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

Example Requests

Removing a specified client ID from a specified OIDC provider

POST https://{endpoint}/v5/oidc-providers/{provider_id}/remove-client-id

{
  "client_id" : "string"
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Abnormal request body.

403

No operation permissions.

404

No resources found.

409

Request conflict.

Error Codes

See Error Codes.