Obtaining Identity Source Configurations

Function

This API is used to obtain identity source configurations of an IAM Identity Center service instance. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

GET /v1/instances/{instance_id}/identity-store-associations

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Globally unique ID of an IAM Identity Center instance.

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

**Table 3** Parameters in the response body
Parameter	Type	Description
identity_store_associations	Array of IdentityStoreDto objects	Configuration of the identity source associated with an IAM Identity Center service instance.

**Table 4** IdentityStoreDto
Parameter	Type	Description
identity_store_id	String	Globally unique ID of the identity source associated with an IAM Identity Center instance.
identity_store_type	String	Identity source type.
authentication_type	String	Login authentication type.
provisioning_type	Array of strings	Provisioning type.
status	String	Whether the identity source is enabled.

Status code: 400

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

Status code: 403

**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.
encoded_authorization_message	String	Encrypted error message.

Status code: 404

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

Example Request

Obtaining identity source configurations of an IAM Identity Center service instance

GET https://{hostname}/v1/instances/{instance_id}/identity-store-associations

Example Response

Status code: 200

Successful

{
  "identity_store_associations" : [ {
    "identity_store_id" : "d-xxxxx",
    "identity_store_type" : "UserPool",
    "authentication_type" : "SAML_2.0",
    "provisioning_type" : [ "DEFAULT" ],
    "status" : "ENABLED"
  } ]
}