查询应用程序详情 - DescribeApplication

功能介绍

查询应用程序详情。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
IdentityCenter:application:describeApplication	Read	application *	-	-	organizations:delegatedAdministrators:list

调试

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

URI

GET /v1/instances/{instance_id}/applications/{application_instance_id}

表1 路径参数
参数	是否必选	参数类型	描述
instance_id	是	String	IAM Identity Center实例的全局唯一标识符（ID）
application_instance_id	是	String	应用程序实例ID，以app-ins-为前缀

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Security-Token	否	String	如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
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	华为云账号

表4 AssignmentConfigDto
参数	参数类型	描述
assignment_required	Boolean	应用程序是否需要分配

表5 PortalOptionsDto
参数	参数类型	描述
visible	Boolean	应用程序在门户是否可见
visibility	String	应用程序在门户可见性
sign_in_options	SignInOptionsDto object	门户登录选项

表6 SignInOptionsDto
参数	参数类型	描述
origin	String	IAM身份中心跳转应用程序的方式
application_url	String	接受应用程序身份验证请求的Url

状态码：400

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
request_id	String	请求唯一标识

状态码：403

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
request_id	String	请求唯一标识
encoded_authorization_message	String	加密的错误信息

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
request_id	String	请求唯一标识

请求示例

查询应用程序详情

GET https://{hostname}/v1/instances/{instance_id}/applications/{application_instance_id}

响应示例

状态码：200

Successful

{
  "application_urn" : "IdentityCenter::8c1eef3a241945f69c3dxxxxx: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::8c1eef3a241945f69c3d3axxxxx:instance:ins-36218e5b4c2c0504",
  "name" : "ApplicationStartUrl",
  "portal_options" : {
    "visible" : true,
    "visibility" : "ENABLED",
    "sign_in_options" : {
      "origin" : "IDENTITY_CENTER",
      "application_url" : ""
    }
  },
  "status" : "ENABLED",
  "application_account" : "8c1eef3a241945f69c3d3a6b0252e783"
}