列出应用程序提供者
功能介绍
查询应用程序提供者列表。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/application-providers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每个请求返回的最大结果数。 |
marker |
否 |
String |
分页标记 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
application_providers |
Array of ApplicationProviderDto objects |
应用程序提供商列表 |
page_info |
PageInfoDto object |
分页信息 |
参数 |
参数类型 |
描述 |
---|---|---|
application_provider_urn |
String |
应用程序提供者URN |
display_data |
DisplayDataDto object |
应用程序提供者显示信息 |
federation_protocol |
String |
支持的协议 |
application_provider_id |
String |
应用程序提供者唯一标识符(ID) |
参数 |
参数类型 |
描述 |
---|---|---|
description |
String |
应用程序提供商描述 |
display_name |
String |
应用程序提供商显示名 |
icon_url |
String |
应用程序提供商图标 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
加密的错误信息 |
请求示例
查询应用程序提供者列表
GET https://{hostname}/v1/application-providers
响应示例
状态码:200
Successful
{ "application_providers" : [ { "application_provider_id" : "app-xxxxxx", "application_provider_urn" : "IdentityCenter::x-xxxxx", "display_data" : { "description" : "description", "display_name" : "custom-saml" }, "federation_protocol" : "SAML" } ], "page_info" : { "next_marker" : null, "current_count" : 1 } }
状态码
状态码 |
描述 |
---|---|
200 |
Successful |
400 |
Bad request |
403 |
Forbidden |
错误码
请参见错误码。