列出应用程序模板
功能介绍
查询应用程序模板列表。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/application-templates
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
application_id |
是 |
String |
应用程序ID，以app-为前缀 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
application_templates |
Array of ApplicationTemplateDto objects |
应用程序模板列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
application |
应用程序模板显示信息 |
|
|
response_config |
ResponseConfigDto object |
应用程序属性配置信息 |
|
response_schema_config |
ResponseSchemaConfigDto object |
应用程序属性映射配置信息 |
|
sso_protocol |
String |
支持的协议 |
|
security_config |
SecurityConfigDto object |
证书配置信息 |
|
service_provider_config |
ServiceProviderConfigDto object |
服务提供商配置信息 |
|
template_id |
String |
应用程序模板唯一标识ID |
|
template_version |
String |
应用程序模板版本 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
application_id |
String |
应用程序Id,以app-为前缀 |
|
display |
DisplayDto object |
应用程序显示信息 |
|
application_type |
String |
应用程序类型 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
properties |
Map<String,ResponseSourceDetailsDto> |
额外添加的属性映射配置 |
|
subject |
ResponseSourceDetailsDto object |
Subject属性映射配置 |
|
relay_state |
String |
中继状态 |
|
ttl |
String |
会话过期时间 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
properties |
Map<String,ResponseSchemaPropertiesDetailsDto> |
额外添加的属性映射Schema配置 |
|
subject |
Subject属性映射Schema配置 |
|
|
supported_name_id_formats |
Array of strings |
应用程序支持的Subject NameID格式 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
attr_name_format |
String |
额外添加的属性的格式 |
|
include |
String |
是否包含额外属性 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name_id_format |
String |
NameID的格式 |
|
include |
String |
是否包含NameID |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
audience |
String |
SAML受众 |
|
require_request_signature |
Boolean |
是否需要签名 |
|
consumers |
Array of ConsumersDto objects |
SAML响应接收方 |
|
start_url |
String |
应用程序启动Url |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
binding |
String |
SAML传输协议 |
|
default_value |
Boolean |
是否是默认接收方 |
|
location |
String |
SAML ACS Url |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
request_id |
String |
请求唯一标识 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
request_id |
String |
请求唯一标识 |
|
encoded_authorization_message |
String |
加密的错误信息 |
请求示例
查询应用程序模板列表
GET https://{hostname}/v1/application-templates
响应示例
状态码：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"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Successful |
|
400 |
Bad request |
|
403 |
Forbidden |
错误码
请参见错误码。
