Help Center/ IAM Identity Center/ API Reference/ API/ Application Management/ Listing Preset Application Templates in the Application Directory

Updated on 2025-08-21 GMT+08:00

View PDF

Listing Preset Application Templates in the Application Directory

Function

This API is used to list preset application templates in the application directory. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

GET /v1/catalog/applications

**Table 1** 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 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
applications	Array of ApplicationTemplateDisplayDto objects	Application list in the application directory.
page_info	PageInfoDto object	Pagination information.

**Table 4** 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 5** DisplayDto
Parameter	Type	Description
description	String	Application description.
display_name	String	Application display name.
icon	String	Application icon.

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

Example Request

Listing preset application templates in the application directory

GET https://{hostname}/v1/catalog/applications

Example Response

Status code: 200

Successful

{
  "applications" : [ {
    "application_id" : "app-e7f300xxxxx",
    "display" : {
      "description" : "description",
      "display_name" : "custom-saml"
    }
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}