列出应用程序
功能介绍
查询应用程序列表。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/instances/{instance_id}/applications
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
instance_id |
是 |
String |
IAM Identity Center实例的全局唯一标识符（ID） |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
每个请求返回的最大结果数。 |
|
marker |
否 |
String |
分页标记 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
applications |
Array of ApplicationDto objects |
应用程序列表 |
|
page_info |
PageInfoDto object |
分页信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
application_urn |
String |
应用程序URN |
|
application_provider_urn |
String |
应用程序提供商URN |
|
assignment_config |
AssignmentConfigDto object |
应用程序是否需要分配 |
|
created_date |
Long |
应用程序创建时间 |
|
description |
String |
应用程序描述 |
|
instance_urn |
String |
IAM身份中心实例URN |
|
name |
String |
应用程序显示名称 |
|
portal_options |
PortalOptionsDto object |
门户选项设置 |
|
status |
String |
应用程序状态 |
|
application_account |
String |
华为云账号 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
visible |
Boolean |
应用程序在门户是否可见 |
|
visibility |
String |
应用程序在门户可见性 |
|
sign_in_options |
SignInOptionsDto object |
门户登录选项 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
origin |
String |
IAM身份中心跳转应用程序的方式 |
|
application_url |
String |
接受应用程序身份验证请求的Url |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
next_marker |
String |
如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null |
|
current_count |
Integer |
本页返回条目数量 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
request_id |
String |
请求唯一标识 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
request_id |
String |
请求唯一标识 |
|
encoded_authorization_message |
String |
加密的错误信息 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
request_id |
String |
请求唯一标识 |
请求示例
查询应用程序列表
GET https://{hostname}/v1/instances/{instance_id}/applications
响应示例
状态码：200
Successful
{
"applications" : [ {
"application_urn" : "IdentityCenter::8c1eef3a241945f69c3d3a6b0xxxxx: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::8c1eef3a241945f69c3d3a6bxxxxx:instance:ins-36218e5b4c2c0504",
"name" : "ApplicationStartUrl",
"portal_options" : {
"visible" : true,
"visibility" : "ENABLED",
"sign_in_options" : {
"origin" : "IDENTITY_CENTER",
"application_url" : ""
}
},
"status" : "ENABLED",
"application_account" : "8c1eef3a241945f69c3d3a6b0252e783"
} ],
"page_info" : {
"next_marker" : null,
"current_count" : 1
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Successful |
|
400 |
Bad request |
|
403 |
Forbidden |
|
404 |
Not found |
错误码
请参见错误码。
