更新时间:2025-08-14 GMT+08:00
分享

列出应用程序实例

功能介绍

列出应用程序实例。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/instances/{instance_id}/application-instances

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

String

IAM Identity Center实例的全局唯一标识符(ID)

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每个请求返回的最大结果数。

marker

String

分页标记

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

application_instances

Array of ApplicationInstanceDto objects

应用程序实例列表

page_info

PageInfoDto object

分页信息

表5 ApplicationInstanceDto

参数

参数类型

描述

active_certificate

CertificateDto object

已激活的证书

display

DisplayDto object

应用程序显示信息

identity_provider_config

IdentityProviderConfigDto object

身份提供商配置信息

application_instance_id

String

应用程序实例唯一标识ID

name

String

应用程序UUID

visible

Boolean

应用程序在门户是否可见

response_config

ResponseConfigDto object

应用程序属性配置信息

response_schema_config

ResponseSchemaConfigDto object

应用程序Schema属性映射配置信息

security_config

SecurityConfigDto object

证书配置信息

status

String

应用程序实例状态

template

ApplicationTemplateDto object

应用程序所依赖模板信息

service_provider_config

ServiceProviderConfigDto object

服务提供商配置信息

client_id

String

OIDC Client ID

end_user_visible

Boolean

用户是否可见

managed_account

String

组员所属账号ID

表6 CertificateDto

参数

参数类型

描述

algorithm

String

证书生成算法

certificate

String

应用程序证书

certificate_id

String

应用程序证书Id

expiry_date

Long

证书过期时间

status

String

证书状态

key_size

String

密钥大小

issue_date

Long

证书生成时间

表7 IdentityProviderConfigDto

参数

参数类型

描述

issuer_url

String

身份提供商issuer

metadata_url

String

身份提供商元数据

remote_login_url

String

身份提供商远程登录链接

remote_logout_url

String

身份提供商远程登出链接

表8 ApplicationTemplateDto

参数

参数类型

描述

application

ApplicationTemplateDisplayDto object

应用程序模板显示信息

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

应用程序模板版本

表9 ApplicationTemplateDisplayDto

参数

参数类型

描述

application_id

String

应用程序Id,以app-为前缀

display

DisplayDto object

应用程序显示信息

application_type

String

应用程序类型

表10 DisplayDto

参数

参数类型

描述

description

String

应用程序描述

display_name

String

应用程序显示名称

icon

String

应用程序图标

表11 ResponseConfigDto

参数

参数类型

描述

properties

Map<String,ResponseSourceDetailsDto>

额外添加的属性映射配置

subject

ResponseSourceDetailsDto object

Subject属性映射配置

relay_state

String

中继状态

ttl

String

会话过期时间

表12 ResponseSourceDetailsDto

参数

参数类型

描述

source

Array of strings

属性映射值

表13 ResponseSchemaConfigDto

参数

参数类型

描述

properties

Map<String,ResponseSchemaPropertiesDetailsDto>

额外添加的属性映射Schema配置

subject

ResponseSchemaSubjectDetailsDto object

Subject属性映射Schema配置

supported_name_id_formats

Array of strings

应用程序支持的Subject NameID格式

表14 ResponseSchemaPropertiesDetailsDto

参数

参数类型

描述

attr_name_format

String

额外添加的属性的格式

include

String

是否包含额外属性

表15 ResponseSchemaSubjectDetailsDto

参数

参数类型

描述

name_id_format

String

NameID的格式

include

String

是否包含NameID

表16 SecurityConfigDto

参数

参数类型

描述

ttl

String

证书过期时间

表17 ServiceProviderConfigDto

参数

参数类型

描述

audience

String

SAML受众

require_request_signature

Boolean

是否需要签名

consumers

Array of ConsumersDto objects

SAML响应接收方

start_url

String

应用程序启动Url

表18 ConsumersDto

参数

参数类型

描述

binding

String

SAML传输协议

default_value

Boolean

是否是默认接收方

location

String

SAML ACS Url

表19 PageInfoDto

参数

参数类型

描述

next_marker

String

如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null

current_count

Integer

本页返回条目数量

状态码:400

表20 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

request_id

String

请求唯一标识

状态码:403

表21 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

request_id

String

请求唯一标识

encoded_authorization_message

String

加密的错误信息

请求示例

列出应用程序实例

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

响应示例

状态码:200

Successful

{
  "applications" : [ {
    "application_urn" : "IdentityCenter::8c1eef3a241945f69xxxxxxx:application:ins-36xxxxxxx/apl-e7f300xxxxx",
    "application_provider_urn" : "IdentityCenter:::applicationProvider:custom-saml",
    "assignment_config" : {
      "assignment_required" : true
    },
    "created_date" : 1752041671967,
    "description" : "ApplicationStartUrl",
    "instance_urn" : "IdentityCenter::8c1eef3a241xxxxx:instance:ins-36218exxxxxxx",
    "name" : "ApplicationStartUrl",
    "portal_options" : {
      "visible" : true,
      "visibility" : "ENABLED",
      "sign_in_options" : {
        "origin" : "IDENTITY_CENTER",
        "application_url" : ""
      }
    },
    "status" : "ENABLED",
    "application_account" : "8c1eef3a241xxxxxx"
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}

状态码

状态码

描述

200

Successful

400

Bad request

403

Forbidden

错误码

请参见错误码

相关文档