Help Center/ IAM Identity Center/ API Reference/ API/ Application Management/ Listing Applications
Updated on 2025-11-27 GMT+08:00
View PDF

Listing Applications

Function

This API is used to list applications. 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}/applications

Table 1 Path parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Globally unique ID of an IAM Identity Center instance.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Maximum number of results returned for each request.

marker

No

String

Pagination marker.

Request Parameters

Table 3 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 4 Parameters in the response body

Parameter

Type

Description

applications

Array of ApplicationDto objects

Application list.

page_info

PageInfoDto object

Pagination information.
Table 5 ApplicationDto

Parameter

Type

Description

application_urn

String

Application URN.

application_provider_urn

String

Application provider URN.

assignment_config

AssignmentConfigDto object

Whether an application needs to be assigned.

created_date

Long

Time when an application is created.

description

String

Application description.

instance_urn

String

URN of an IAM Identity Center instance.

name

String

Application display name.

portal_options

PortalOptionsDto object

Portal option settings.

status

String

Application status.

application_account

String

Huawei Cloud account.
Table 6 AssignmentConfigDto

Parameter

Type

Description

assignment_required

Boolean

Whether an application needs to be assigned.
Table 7 PortalOptionsDto

Parameter

Type

Description

visible

Boolean

Whether an application is visible on the user portal.

visibility

String

Application visibility on the portal.

sign_in_options

SignInOptionsDto object

Portal login options.
Table 8 SignInOptionsDto

Parameter

Type

Description

origin

String

Method of redirecting to an application from IAM Identity Center.

application_url

String

URL for receiving application authentication requests.
Table 9 PageInfoDto

Parameter

Type

Description

next_marker

String

If present, more output is available than that included in the current response. To get the next part of the output, use this value in the request parameter in a subsequent call to the same API. You should repeat calling until the next_marker parameter is null in a response.

current_count

Integer

Number of items returned on this page.

Status code: 400

Table 10 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 11 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 12 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 applications

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

Example Response

Status code: 200

Successful

{
  "applications" : [ {
    "application_urn" : "IdentityCenter::8c1eef3a241945f69c3d3a6b0xxxxx:application:ins-36218e5b4c2c0504/apl-e7f30081e5ff428c",
    "application_provider_urn" : "IdentityCenter:::applicationProvider:custom-saml",
    "assignment_config" : {
      "assignment_required" : true
    },
    "created_date" : 1752041671967,
    "description" : "ApplicationStartUrl",
    "instance_urn" : "IdentityCenter::8c1eef3a241945f69c3d3a6bxxxxx:instance:ins-36218e5b4c2c0504",
    "name" : "ApplicationStartUrl",
    "portal_options" : {
      "visible" : true,
      "visibility" : "ENABLED",
      "sign_in_options" : {
        "origin" : "IDENTITY_CENTER",
        "application_url" : ""
      }
    },
    "status" : "ENABLED",
    "application_account" : "8c1eef3a241945f69c3d3a6b0252e783"
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

404

Not found.

Error Codes

For details, see Error Codes.

Parent topic: Application Management