Listing Instances

Function

This API is used to query the instance list of IAM Identity Center.

URI

GET /v1/instances

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results returned for each request Minimum value: 1 Maximum value: 100 Default value: 100
marker	No	String	Pagination marker Minimum length: 24 Maximum length: 24

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. Maximum length: 2048

Response Parameters

Status code: 200

**Table 3** Parameters in the response body
Parameter	Type	Description
instances	Array of objects	IAM Identity Center instance list
page_info	Object	Pagination information

**Table 4** instances
Parameter	Type	Description
identity_store_id	String	Globally unique identifier (ID) of the identity source associated with an IAM Identity Center instance Minimum length: 1 Maximum length: 64
instance_id	String	Globally unique ID of an IAM Identity Center instance Minimum length: 20 Maximum length: 20
alias	String	User-defined alias for the identity source ID
instance_urn	String	Uniform Resource Name (URN) of an instance

**Table 5** page_info
Parameter	Type	Description
next_marker	String	If present, it indicates that the available output is more than the output contained in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this operation until the next_marker response returns null.
current_count	Integer	Number of records returned on this page

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

Example Request

Listing the instance list of IAM Identity Center

GET https://{hostname}/v1/instances

Example Response

Status code: 200

Successful

{
  "instances" : [ {
    "identity_store_id" : "d-a00aaaa33f",
    "alias" : "new-store-id-123",
    "instance_id" : "ins-bd8baaaaaaaade60"
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}