查询用户有权限的资源,包括代码库和代码组。
适用版本 | 企业标准版、regional |
服务接入点与授权信息
获取服务接入点,替换 API 请求语法中的 <domain> :服务接入点(domain)。
获取个人访问令牌,具体操作,请参见获取个人访问令牌。
获取organizationId,请前往组织管理后台的基本信息页面获取组织 ID 。
产品 | 资源 | 所需权限 |
代码管理 | 用户资源 | 只读 |
请求语法
GET https://{domain}/oapi/v1/codeup/organizations/{organizationId}/users/vision/user_resources请求头
参数 | 类型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 个人访问令牌。 | pt-0fh3****0fbG_35af****0484 |
请求参数
参数 | 类型 | 位置 | 是否必填 | 描述 | 示例值 |
organizationId | string | path | 是 | 组织 ID。 | 60d54f3daccf2bbd6659f3ad |
user_ids | string | query | 否 | 用户 ID 列表,多个用逗号分隔。 | 62c795xxxb468af8,62c795xxxb468af9 |
page | integer | query | 否 | 页码,默认从1开始。 | 1 |
per_page | integer | query | 否 | 每页大小,默认10,最大20。 | 10 |
请求示例
curl -X 'GET' \
'https://{domain}/oapi/v1/codeup/organizations/60d54f3daccf2bbd6659f3ad/users/vision/user_resources?user_ids=62c795xxxb468af8,62c795xxxb468af9&page=1&per_page=10' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'返回参数
参数 | 类型 | 描述 | 示例值 |
- | array | ||
- | object | ||
group_infos | array | 用户所属的代码组列表。 | |
- | object | ||
group_info | object | ||
avatarUrl | string | 头像地址。 | https://example.com/avatar.png |
createdAt | string | 创建时间。 | 2024-10-05T15:30:45Z |
description | string | 代码组描述。 | 代码组描述信息 |
id | integer | 代码组 ID。 | 2813489 |
name | string | 代码组名称。 | demo-group |
path | string | 代码组路径。 | demo-group |
updatedAt | string | 更新时间。 | 2024-10-05T15:30:45Z |
visibility | string | 可见性:private-私有,internal-内部公开,public-公开。 | private |
role_info | object | ||
access_level | integer | 访问权限:20-浏览者,30-开发者,40-管理员。 | 30 |
cn_role_name | string | 角色名称(中文)。 | 开发者 |
en_role_name | string | 角色名称(英文)。 | Developer |
source_id | integer | 资源 ID。 | 2813489 |
source_type | string | 资源类型:PROJECT-代码库,NAMESPACE-代码组。 | PROJECT |
repository_infos | array | 用户所属的代码库列表。 | |
- | object | ||
repository_info | object | ||
avatarUrl | string | 头像地址。 | https://example.com/avatar.png |
createdAt | string | 创建时间。 | 2024-10-05T15:30:45Z |
defaultBranch | string | 默认分支。 | master |
description | string | 代码库描述。 | 代码库描述信息 |
httpUrlToRepo | string | HTTP 克隆地址。 | https://example.com/demo-group/demo-repo.git |
id | integer | 代码库 ID。 | 2813489 |
lastActivityAt | string | 最后活跃时间。 | 2024-10-05T15:30:45Z |
name | string | 代码库名称。 | demo-repo |
nameWithNamespace | string | 代码库完整名称(含完整组名称)。 | demo-group / demo-repo |
path | string | 代码库路径。 | demo-repo |
sshUrlToRepo | string | SSH 克隆地址。 | git@example.com:demo-group/demo-repo.git |
updatedAt | string | 更新时间。 | 2024-10-05T15:30:45Z |
visibility | string | 可见性:private-私有,internal-内部公开,public-公开。 | private |
role_info | object | ||
access_level | integer | 访问权限:20-浏览者,30-开发者,40-管理员。 | 30 |
cn_role_name | string | 角色名称(中文)。 | 开发者 |
en_role_name | string | 角色名称(英文)。 | Developer |
source_id | integer | 资源 ID。 | 2813489 |
source_type | string | 资源类型:PROJECT-代码库,NAMESPACE-代码组。 | PROJECT |
user_info | object | ||
avatarUrl | string | 头像地址。 | https://example.com/avatar.png |
string | 邮箱。 | zhangsan@example.com | |
id | integer | 用户 ID。 | 2813489 |
name | string | 用户名称。 | 张三 |
username | string | 用户名。 | zhangsan |
返回示例
[
{
"group_infos": [
{
"group_info": {
"avatarUrl": "https://example.com/avatar.png",
"createdAt": "2024-10-05T15:30:45Z",
"description": "代码组描述信息",
"id": 2813489,
"name": "demo-group",
"path": "demo-group",
"updatedAt": "2024-10-05T15:30:45Z",
"visibility": "private"
},
"role_info": {
"access_level": 30,
"cn_role_name": "开发者",
"en_role_name": "Developer",
"source_id": 2813489,
"source_type": "PROJECT"
}
}
],
"repository_infos": [
{
"repository_info": {
"avatarUrl": "https://example.com/avatar.png",
"createdAt": "2024-10-05T15:30:45Z",
"defaultBranch": "master",
"description": "代码库描述信息",
"httpUrlToRepo": "https://example.com/demo-group/demo-repo.git",
"id": 2813489,
"lastActivityAt": "2024-10-05T15:30:45Z",
"name": "demo-repo",
"nameWithNamespace": "demo-group / demo-repo",
"path": "demo-repo",
"sshUrlToRepo": "git@example.com:demo-group/demo-repo.git",
"updatedAt": "2024-10-05T15:30:45Z",
"visibility": "private"
},
"role_info": {
"access_level": 30,
"cn_role_name": "开发者",
"en_role_name": "Developer",
"source_id": 2813489,
"source_type": "PROJECT"
}
}
],
"user_info": {
"avatarUrl": "https://example.com/avatar.png",
"email": "zhangsan@example.com",
"id": 2813489,
"name": "张三",
"username": "zhangsan"
}
}
]
响应头
参数 | 描述 | 示例值 |
x-next-page | 下一页。 | 2 |
x-page | 当前页。 | 1 |
x-per-page | 每页大小。 | 10 |
x-prev-page | 上一页。 | 0 |
x-total | 总条数。 | 100 |
x-total-pages | 总页数。 | 10 |
错误码
访问错误码中心查看 API 相关错误码。