Help Center/ IAM Identity Center/ API Reference/ API/ Identity Provider Management/ Enabling an External Identity Provider
Updated on 2025-08-21 GMT+08:00
View PDF
Share

Enabling an External Identity Provider

Function

This API is used to enable an external identity provider. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

POST /v1/identity-stores/{identity_store_id}/external-idp/{idp_id}/enable

Table 1 Path parameters

Parameter

Mandatory

Type

Description

identity_store_id

Yes

String

Globally unique ID of an identity source.

idp_id

Yes

String

Globally unique ID of an external identity provider.

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 200

Successful

Status code: 400

Table 3 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Status code: 403

Table 4 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

encoded_authorization_message

String

Encrypted error message.

Example Request

Enabling an external identity provider

POST https://{hostname}/v1/identity-stores/{identity_store_id}/external-idp/{idp_id}/enable

Example Response

None

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

Error Codes

For details, see Error Codes.