Help Center/ IAM Identity Center/ API Reference/ API/ Application Management/ Updating Service Provider Configurations for an Application Instance
Updated on 2025-08-21 GMT+08:00

Updating Service Provider Configurations for an Application Instance

Function

This API is used to update service provider configurations for an application instance. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

PUT /v1/instances/{instance_id}/application-instances/{application_instance_id}/service-provider-configuration

Table 1 Path parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Globally unique ID of an IAM Identity Center instance.

application_instance_id

Yes

String

Application instance ID. Its prefix is app-ins-.

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

service_provider_config

Yes

ServiceProviderConfigDto object

Service provider configuration.

Table 4 ServiceProviderConfigDto

Parameter

Mandatory

Type

Description

audience

Yes

String

SAML audience.

require_request_signature

No

Boolean

Whether a signature is required.

consumers

Yes

Array of ConsumersDto objects

SAML response recipient.

start_url

No

String

Application startup URL.

Table 5 ConsumersDto

Parameter

Mandatory

Type

Description

binding

Yes

String

SAML transmission protocol.

default_value

Yes

Boolean

Whether it is the default recipient.

location

Yes

String

SAML ACS URL.

Response Parameters

Status code: 200

Successful

Status code: 400

Table 6 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 7 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.

Status code: 404

Table 8 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.

Example Request

Updating service provider configurations of an application instance

PUT https://{hostname}/v1/instances/{instance_id}/application-instances/{application_instance_id}/service-provider-configuration

{
  "service_provider_config" : {
    "audience" : "https://xxx.example.com",
    "require_request_signature" : false,
    "consumers" : [ {
      "location" : "https://xxx.example.com/acs",
      "binding" : "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST",
      "default_value" : true
    } ],
    "start_url" : "https://xxx.example.com/acs"
  }
}

Example Response

None

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

404

Not found.

Error Codes

For details, see Error Codes.