2.23. team
创建、列出和管理组织的团队。
2.23.1. getOrganizationTeamPermissions
返回机构团队的存储库权限列表。
GET /api/v1/organization/{orgname}/team/{teamname}/permissions
授权:
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
TeamName | 团队的名称 | 字符串 |
path |
需要OrgName | 机构名称 | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 成功调用 | |
400 | 错误请求 | |
401 | 需要会话 | |
403 | 未授权访问 | |
404 | 未找到 |
2.23.2. updateOrganizationTeamMember
向现有团队添加或邀请成员。
PUT /api/v1/organization/{orgname}/team/{teamname}/members/{membername}
授权: oauth2_implicit (org:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
TeamName | 团队的名称 | 字符串 |
path |
需要 memberName | 团队成员的用户名 | string |
path |
需要OrgName | 机构名称 | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 成功调用 | |
400 | 错误请求 | |
401 | 需要会话 | |
403 | 未授权访问 | |
404 | 未找到 |
示例命令
$ curl -X PUT \ -H "Authorization: Bearer <your_access_token>" \ "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"
2.23.3. deleteOrganizationTeamMember
删除团队成员。
If the user is merely invited to join the team, then the invite is removed instead.
DELETE /api/v1/organization/{orgname}/team/{teamname}/members/{membername}
授权: oauth2_implicit (org:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
TeamName | 团队的名称 | 字符串 |
path |
需要 memberName | 团队成员的用户名 | string |
path |
需要OrgName | 机构名称 | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
204 | 已删除 | |
400 | 错误请求 | |
401 | 需要会话 | |
403 | 未授权访问 | |
404 | 未找到 |
示例命令
$ curl -X DELETE \ -H "Authorization: Bearer <your_access_token>" \ "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"
2.23.4. getOrganizationTeamMembers
检索指定团队的成员列表。
GET /api/v1/organization/{orgname}/team/{teamname}/members
授权: oauth2_implicit (org:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
TeamName | 团队的名称 | 字符串 |
path |
需要OrgName | 机构名称 | 字符串 |
查询参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
query |
includePending | 是否包含待处理的成员 | 布尔值 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 成功调用 | |
400 | 错误请求 | |
401 | 需要会话 | |
403 | 未授权访问 | |
404 | 未找到 |
示例命令
$ curl -X GET \ -H "Authorization: Bearer <your_access_token>" \ "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members"
2.23.5. inviteTeamMemberEmail
邀请现有团队的电子邮件地址。
PUT /api/v1/organization/{orgname}/team/{teamname}/invite/{email}
授权: oauth2_implicit (org:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
需要 发送电子邮件 | string | |
path |
TeamName | 字符串 | |
path |
需要OrgName | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 成功调用 | |
400 | 错误请求 | |
401 | 需要会话 | |
403 | 未授权访问 | |
404 | 未找到 |
示例命令
$ curl -X PUT \ -H "Authorization: Bearer <your_access_token>" \ "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"
2.23.6. deleteTeamMemberEmailInvite
删除电子邮件地址邀请您加入团队。
DELETE /api/v1/organization/{orgname}/team/{teamname}/invite/{email}
授权: oauth2_implicit (org:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
需要 发送电子邮件 | string | |
path |
TeamName | 字符串 | |
path |
需要OrgName | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
204 | 已删除 | |
400 | 错误请求 | |
401 | 需要会话 | |
403 | 未授权访问 | |
404 | 未找到 |
示例命令
+
$ curl -X DELETE \ -H "Authorization: Bearer <your_access_token>" \ "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"
2.23.7. updateOrganizationTeam
为指定团队更新机构范围权限。
此 API 也用于创建团队。
PUT /api/v1/organization/{orgname}/team/{teamname}
授权: oauth2_implicit (org:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
TeamName | 团队的名称 | 字符串 |
path |
需要OrgName | 机构名称 | 字符串 |
请求正文模式(application/json)
团队的描述
名称 | 描述 | 模式 |
---|---|---|
需要 角色 | 应用于团队的机构权限 | 字符串 |
description | team 的 Markdown 描述 | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 成功调用 | |
400 | 错误请求 | |
401 | 需要会话 | |
403 | 未授权访问 | |
404 | 未找到 |
示例命令
$ curl -k -X PUT -H 'Accept: application/json' -H 'Content-Type: application/json' -H "Authorization: Bearer <bearer_token>" --data '{"role": "creator"}' https://<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>
2.23.8. deleteOrganizationTeam
删除指定的团队。
DELETE /api/v1/organization/{orgname}/team/{teamname}
授权: oauth2_implicit (org:admin)
路径参数
类型 | Name | 描述 | 模式 |
---|---|---|---|
path |
TeamName | 团队的名称 | 字符串 |
path |
需要OrgName | 机构名称 | 字符串 |
响应
HTTP 代码 | 描述 | 模式 |
---|---|---|
204 | 已删除 | |
400 | 错误请求 | |
401 | 需要会话 | |
403 | 未授权访问 | |
404 | 未找到 |
示例命令
$ curl -X DELETE \ -H "Authorization: Bearer <your_access_token>" \ "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>"