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

Listing Application Instances

Function

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

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

application_instances

Array of ApplicationInstanceDto objects

List of application instances.

page_info

PageInfoDto object

Pagination information.
Table 5 ApplicationInstanceDto

Parameter

Type

Description

active_certificate

CertificateDto object

Activated certificates.

display

DisplayDto object

Display information of an application.

identity_provider_config

IdentityProviderConfigDto object

Identity provider configuration.

application_instance_id

String

Unique ID of an application instance.

name

String

Application UUID.

visible

Boolean

Whether an application is visible on the user portal.

response_config

ResponseConfigDto object

Application attribute configuration.

response_schema_config

ResponseSchemaConfigDto object

Configuration for application schema attribute mapping.

security_config

SecurityConfigDto object

Certificate configuration.

status

String

Application instance status.

template

ApplicationTemplateDto object

Information about the template that an application depends on.

service_provider_config

ServiceProviderConfigDto object

Service provider configuration.

client_id

String

OIDC client ID.

end_user_visible

Boolean

Visible to users or not.

managed_account

String

Account ID of a group member.
Table 6 CertificateDto

Parameter

Type

Description

algorithm

String

Certificate generation algorithm.

certificate

String

Application certificate.

certificate_id

String

Application certificate ID.

expiry_date

Long

Certificate expiration time.

status

String

Certificate status.

key_size

String

Key size.

issue_date

Long

Certificate generation time.
Table 7 IdentityProviderConfigDto

Parameter

Type

Description

issuer_url

String

Identity provider issuer.

metadata_url

String

Identity provider metadata.

remote_login_url

String

Remote login link of an identity provider.

remote_logout_url

String

Remote logout link of an identity provider.
Table 8 ApplicationTemplateDto

Parameter

Type

Description

application

ApplicationTemplateDisplayDto object

Display information of an application template.

response_config

ResponseConfigDto object

Application attribute configuration.

response_schema_config

ResponseSchemaConfigDto object

Mapping configuration of application attributes.

sso_protocol

String

Supported protocols.

security_config

SecurityConfigDto object

Certificate configuration.

service_provider_config

ServiceProviderConfigDto object

Service provider configuration.

template_id

String

Unique ID of an application template.

template_version

String

Application template version.
Table 9 ApplicationTemplateDisplayDto

Parameter

Type

Description

application_id

String

Application ID. Its prefix is app-.

display

DisplayDto object

Display information of an application.

application_type

String

Application type.
Table 10 DisplayDto

Parameter

Type

Description

description

String

Application description.

display_name

String

Application display name.

icon

String

Application icon.
Table 11 ResponseConfigDto

Parameter

Type

Description

properties

Map<String,ResponseSourceDetailsDto>

Additional configuration for attribute mapping.

subject

ResponseSourceDetailsDto object

Subject attribute mapping configuration.

relay_state

String

Relay state.

ttl

String

Session expiration time.
Table 12 ResponseSourceDetailsDto

Parameter

Type

Description

source

Array of strings

Attribute mapping value.
Table 13 ResponseSchemaConfigDto

Parameter

Type

Description

properties

Map<String,ResponseSchemaPropertiesDetailsDto>

Additional schema configuration for attribute mapping.

subject

ResponseSchemaSubjectDetailsDto object

Schema configuration for subject attribute mapping.

supported_name_id_formats

Array of strings

Subject NameID format supported by an application.
Table 14 ResponseSchemaPropertiesDetailsDto

Parameter

Type

Description

attr_name_format

String

Additional attribute format.

include

String

Whether additional attributes are included.
Table 15 ResponseSchemaSubjectDetailsDto

Parameter

Type

Description

name_id_format

String

NameID format.

include

String

Whether NameID is included.
Table 16 SecurityConfigDto

Parameter

Type

Description

ttl

String

Certificate expiration time.
Table 17 ServiceProviderConfigDto

Parameter

Type

Description

audience

String

SAML audience.

require_request_signature

Boolean

Whether a signature is required.

consumers

Array of ConsumersDto objects

SAML response recipient.

start_url

String

Application startup URL.
Table 18 ConsumersDto

Parameter

Type

Description

binding

String

SAML transmission protocol.

default_value

Boolean

Whether it is the default recipient.

location

String

SAML ACS URL.
Table 19 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 20 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 21 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

Listing application instances

GET https://{hostname}/v1/instances/{instance_id}/application-instances

Example Response

Status code: 200

Successful

{
  "application_instances": [
    {
      "active_certificate": {
        "algorithm": "SHA256withRSA",
        "certificate": "-----BEGIN CERTIFICATE-----\r\nMIIEzDCC***********r7b7bwtA7lyC5wVnaI5uU=\r\n-----END CERTIFICATE-----",
        "certificate_id": "cer-94b6ee1***********0d5cc7f",
        "expiry_date": 1913587200000,
        "status": "ACTIVE",
        "key_size": "3072",
        "issue_date": 1755825219580
      },
      "display": {
        "description": "***********",
        "display_name": "HuaweiCloud IAM",
        "icon": ""
      },
      "identity_provider_config": {
        "issuer_url": "https://idcenter.huaweicloud.com/v1/saml/assertion/OWVjNmY0ZjVkZDI4NDg1***********WUyZGQ0NDIzMGIzMTk1Yg==",
        "metadata_url": "https://idcenter.huaweicloud.com/v1/saml/metadata/OWVjNmY0ZjVkZDI4ND***********ZGQ0NDIzMGIzMTk1Yg==",
        "remote_login_url": "https://idcenter.huaweicloud.com/v1/saml/assertion/OWVjNmY0Zj***********GQ0NDIzMGIzMTk1Yg==",
        "remote_logout_url": "https://idcenter.huaweicloud.com/v1/saml/logout/OWVjNmY0ZjVkZDI4N***********UyZGQ0NDIzMGIzMTk1Yg=="
      },
      "application_instance_id": "app-ins-1e2dd44230b3195b",
      "name": "439977c1-8b******dca7cfc668bc",
      "visible": true,
      "response_config": {
        "properties": {
          "IAM_SAML_Attributes_domain_id": {
            "source": [
              "9ec********8331"
            ]
          },
          "UserName": {
            "source": [
              "${user:name}"
            ]
          },
          "IAM_SAML_Attributes_idp_id": {
            "source": [
              "IdCCCE"
            ]
          },
          "IAM_SAML_Attributes_redirect_url": {
            "source": [
              "https://console.huaweicloud.com/iam/?agencyId=********region=cn-north-4&locale=en-us#/iam/users"
            ]
          }
        },
        "subject": {
          "source": [
            "${user:name}"
          ]
        },
        "relay_state": null,
        "ttl": "PT1H"
      },
      "response_schema_config": {
        "properties": {
          "IAM_SAML_Attributes_domain_id": {
            "attr_name_format": "urn:oasis:names:tc:SAML:2.0:attrname-format:basic",
            "include": "YES"
          },
          "UserName": {
            "attr_name_format": "urn:oasis:names:tc:SAML:2.0:attrname-format:basic",
            "include": "YES"
          },
          "IAM_SAML_Attributes_idp_id": {
            "attr_name_format": "urn:oasis:names:tc:SAML:2.0:attrname-format:basic",
            "include": "YES"
          },
          "IAM_SAML_Attributes_redirect_url": {
            "attr_name_format": "urn:oasis:names:tc:SAML:2.0:attrname-format:basic",
            "include": "YES"
          }
        },
        "subject": {
          "name_id_format": "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress",
          "include": "REQUIRED"
        },
        "supported_name_id_formats": []
      },
      "security_config": {
        "ttl": "P5Y"
      },
      "status": "ENABLED",
      "template": {
        "application": {
          "application_id": "app-ff1258a63a4a263f",
          "display": {
            "description": "Custom SAML 2.0 application",
            "display_name": "Custom SAML 2.0 application",
            "icon": ""
          },
          "application_type": ""
        },
        "response_config": {
          "properties": {},
          "subject": null,
          "relay_state": null,
          "ttl": "PT1H"
        },
        "response_schema_config": {
          "properties": {},
          "subject": null,
          "supported_name_id_formats": null
        },
        "sso_protocol": "SAML",
        "security_config": {
          "ttl": null
        },
        "service_provider_config": {
          "audience": null,
          "require_request_signature": false,
          "consumers": null,
          "start_url": null
        },
        "template_id": "tpl-88f215b39bfc7575",
        "template_version": "1"
      },
      "service_provider_config": {
        "audience": "https://auth.huaweicloud.com/",
        "require_request_signature": true,
        "consumers": [
          {
            "binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST",
            "default_value": true,
            "location": "https://auth.huaweicloud.com/authui/saml/SAMLAssertionConsumer"
          }
        ],
        "start_url": null
      },
      "client_id": null,
      "end_user_visible": null,
      "managed_account": "9ec6f4f5dd***********c5428331"
    }
  ],
  "page_info": {
    "next_marker": null,
    "current_count": 1
  }
}

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

Error Codes

For details, see Error Codes.

Parent topic: Application Management