Get Assets by Organization¶
获取指定用户在指定 OU 下有权限的所有资源。
前提条件¶
OU 已获取当前应用,或该应用为 OU 内自建应用。
应用已拥有“获取本 OU 内所有用户的权限信息”的权限。如有需要,联系 OU 管理员获取权限。
请求格式¶
POST https://{apigw-address}/app-portal-service/v2.2/user/asset/list
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
userId |
必需 |
String |
用户 ID。如何获取 orgId 信息 >> |
orgId |
必需 |
String |
OU ID。如何获取 orgId 信息 >> |
pagination |
可选 |
Pagination 请求结构体 |
分页参数。若不提供,则默认按照每页 1000 条数据的格式返回第 0 页的数据。Pagination 请求结构体 >> |
resourceTypes |
可选 |
Array |
按指定的资源类型过滤资源,支持输入最多 1000 种资源类型。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
pagination |
Pagination 结构体 |
分页信息。Pagination 结构体 >> |
assets |
Assets 结构体 |
资源信息列表。Assets 结构体 >> |
Pagination 结构体 ¶
名称 |
数据类型 |
描述 |
---|---|---|
pageNo |
Integer |
请求页数。 |
pageSize |
Integer |
每页记录数。 |
totalElements |
Long |
总记录数。 |
Assets 结构体 ¶
名称 |
数据类型 |
描述 |
---|---|---|
id |
String |
资源 ID。 |
name |
I18nString |
该资源的国际化名称。 |
type |
String |
资源类型代码。 |
typeName |
I18nString |
资源类型的国际化名称。 |
错误码¶
代码 |
描述 |
---|---|
31400 |
用户 ID 或 OU ID 不能为空。 |
31403 |
应用未被授权访问用户信息或资源信息。 |
31404 |
未找到对应用户或此用户在不存在于该 OU。 |
示例¶
请求示例¶
url: https://{apigw-address}/app-portal-service/v2.2/user/asset/list
method: POST
{
"userId": "yourUserId",
"orgId": "yourOrgId",
"resourceTypes": ["type1", "type2"],
"pagination": {
"pageNo": 0,
"pageSize": 1000,
}
}
返回示例¶
{
"code": 0,
"message": "OK",
"data": {
"pagination": {
"totalElements": 1,
"pageNo": 0,
"pageSize": 1000
},
"assets": [
{
"id": "your_asset_id",
"name": {
"default": "autoTree",
"en_US": "autoTree_EN",
"zh_CN": "自动化树",
"es_ES": "menús",
"ja_JP": "自動化ツリー"
},
"type": "auth_unit",
"typeName": {
"default": "Physical Resource",
"en_US": "Physical Resource",
"zh_CN": "实体资产"
}
}
]
}
}