2.17. robot
管理用户和机构机器帐户。
2.17.1. getUserRobots 复制链接链接已复制到粘贴板!
列出用户的可用机器人。
GET /api/v1/user/robots
授权: oauth2_implicit (user:admin)
查询参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
query |
限制 | 如果指定,则要返回的机器数。 | 整数 |
query |
Token | 如果为 false,则不会返回机器令牌。 | 布尔值 |
query |
权限 | 是否包括机器人具有权限的存储库和团队。 | 布尔值 |
响应
2.17.2. getOrgRobotPermissions 复制链接链接已复制到粘贴板!
返回机构机器机器的存储库权限列表。
GET /api/v1/organization/{orgname}/robots/{robot_shortname}/permissions
授权: oauth2_implicit (user:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
robot_shortname | robot 的短名称,没有任何用户或机构前缀 | 字符串 |
path |
OrgName | 机构的名称 | 字符串 |
响应
2.17.3. regenerateOrgRobotToken 复制链接链接已复制到粘贴板!
为机构机器重新生成令牌。
POST /api/v1/organization/{orgname}/robots/{robot_shortname}/regenerate
授权: oauth2_implicit (org:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
robot_shortname | robot 的短名称,没有任何用户或机构前缀 | 字符串 |
path |
OrgName | 机构的名称 | 字符串 |
响应
2.17.4. getUserRobotPermissions 复制链接链接已复制到粘贴板!
返回用户机器机器的存储库权限列表。
GET /api/v1/user/robots/{robot_shortname}/permissions
授权: oauth2_implicit (user:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
robot_shortname | robot 的短名称,没有任何用户或机构前缀 | 字符串 |
响应
2.17.5. regenerateUserRobotToken 复制链接链接已复制到粘贴板!
为用户的机器人重新生成令牌。
POST /api/v1/user/robots/{robot_shortname}/regenerate
授权: oauth2_implicit (user:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
robot_shortname | robot 的短名称,没有任何用户或机构前缀 | 字符串 |
响应
2.17.6. getOrgRobot 复制链接链接已复制到粘贴板!
使用指定名称返回机构机器人。
GET /api/v1/organization/{orgname}/robots/{robot_shortname}
授权: oauth2_implicit (org:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
robot_shortname | robot 的短名称,没有任何用户或机构前缀 | 字符串 |
path |
OrgName | 机构的名称 | 字符串 |
响应
2.17.7. createOrgRobot 复制链接链接已复制到粘贴板!
在机构中创建一个新的机器人。
PUT /api/v1/organization/{orgname}/robots/{robot_shortname}
授权: oauth2_implicit (org:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
robot_shortname | robot 的短名称,没有任何用户或机构前缀 | 字符串 |
path |
OrgName | 机构的名称 | 字符串 |
请求正文模式(application/json)
创建机器机器(robot)的可选数据
名称 | 描述 | 模式 |
---|---|---|
description | robot 的可选文本描述 | 字符串 |
unstructured_metadata | robot 的可选无结构元数据 | 对象 |
响应
2.17.8. deleteOrgRobot 复制链接链接已复制到粘贴板!
删除现有机构机器。
DELETE /api/v1/organization/{orgname}/robots/{robot_shortname}
授权: oauth2_implicit (org:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
robot_shortname | robot 的短名称,没有任何用户或机构前缀 | 字符串 |
path |
OrgName | 机构的名称 | 字符串 |
响应
2.17.9. getOrgRobots 复制链接链接已复制到粘贴板!
列出机构机器人。
GET /api/v1/organization/{orgname}/robots
授权: oauth2_implicit (org:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
OrgName | 机构的名称 | 字符串 |
查询参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
query |
限制 | 如果指定,则要返回的机器数。 | 整数 |
query |
Token | 如果为 false,则不会返回机器令牌。 | 布尔值 |
query |
权限 | 是否包括机器人具有权限的存储库和团队。 | 布尔值 |
响应
2.17.10. getUserRobot 复制链接链接已复制到粘贴板!
使用指定名称返回用户的机器人。
GET /api/v1/user/robots/{robot_shortname}
授权: oauth2_implicit (user:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
robot_shortname | robot 的短名称,没有任何用户或机构前缀 | 字符串 |
响应
2.17.11. createUserRobot 复制链接链接已复制到粘贴板!
使用指定名称创建新用户机器。
PUT /api/v1/user/robots/{robot_shortname}
授权: oauth2_implicit (user:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
robot_shortname | robot 的短名称,没有任何用户或机构前缀 | 字符串 |
请求正文模式(application/json)
创建机器机器(robot)的可选数据
名称 | 描述 | 模式 |
---|---|---|
description | robot 的可选文本描述 | 字符串 |
unstructured_metadata | robot 的可选无结构元数据 | 对象 |
响应
2.17.12. deleteUserRobot 复制链接链接已复制到粘贴板!
删除现有的机器人。
DELETE /api/v1/user/robots/{robot_shortname}
授权: oauth2_implicit (user:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
robot_shortname | robot 的短名称,没有任何用户或机构前缀 | 字符串 |