Listing Application Templates

Function

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

URI

GET /v1/application-templates

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
application_id	Yes	String	Application ID. Its prefix is app-.

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_templates	Array of ApplicationTemplateDto objects	List of application templates.

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

**Table 7** 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 8** ResponseSourceDetailsDto
Parameter	Type	Description
source	Array of strings	Attribute mapping value.

**Table 9** 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 10** ResponseSchemaPropertiesDetailsDto
Parameter	Type	Description
attr_name_format	String	Additional attribute format.
include	String	Whether additional attributes are included.

**Table 11** ResponseSchemaSubjectDetailsDto
Parameter	Type	Description
name_id_format	String	NameID format.
include	String	Whether NameID is included.

**Table 12** SecurityConfigDto
Parameter	Type	Description
ttl	String	Certificate expiration time.

**Table 13** 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 14** ConsumersDto
Parameter	Type	Description
binding	String	SAML transmission protocol.
default_value	Boolean	Whether it is the default recipient.
location	String	SAML ACS URL.

Status code: 400

**Table 15** 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 16** 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 templates

GET https://{hostname}/v1/application-templates

Example Response

Status code: 200

Successful

{
  "application_templates" : [ {
    "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"
  } ]
}