Updating Configurations of an External Identity Provider

Function

This API is used to update configurations of 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

PUT /v1/identity-stores/{identity_store_id}/external-idp/{idp_id}

**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.

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
entity_id	Yes	String	Issuer ID of an identity provider.
login_url	Yes	String	Login link of an identity provider.

Response Parameters

Status code: 200

Successful

Status code: 400

**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.

Status code: 403

**Table 5** 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

Updating configurations of an external identity provider

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

{
  "entity_id" : "https://sts.windows.net/36118e7b-55b4-4a70-xxxxx/",
  "login_url" : "https://login.microsoftonline.com/36118e7b-55b4-xxxxx/saml2"
}