Querying Application Details

Function

This API is used to query application details. 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/{application_instance_id}

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

Response Parameters

Status code: 200

**Table 3** Parameters in the response body
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	Creation time.
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	Status.
application_account	String	Huawei Cloud account.

**Table 4** AssignmentConfigDto
Parameter	Type	Description
assignment_required	Boolean	Whether an application needs to be assigned.

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

Status code: 400

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

Status code: 403

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

Status code: 404

**Table 9** 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

Querying application details

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

Example Response

Status code: 200

Successful

{
  "application_urn" : "IdentityCenter::8c1eef3a241945f69c3dxxxxx: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::8c1eef3a241945f69c3d3axxxxx:instance:ins-36218e5b4c2c0504",
  "name" : "ApplicationStartUrl",
  "portal_options" : {
    "visible" : true,
    "visibility" : "ENABLED",
    "sign_in_options" : {
      "origin" : "IDENTITY_CENTER",
      "application_url" : ""
    }
  },
  "status" : "ENABLED",
  "application_account" : "8c1eef3a241945f69c3d3a6b0252e783"
}