2.11. 机构
管理组织、成员和 OAuth 应用程序。
2.11.1. createOrganization
创建新机构。
POST /api/v1/organization/
Authorizations: oauth2_implicit(user:admin)
请求正文模式(application/json)
新组织的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
name | 机构用户名 | 字符串 |
|
email | 机构联系电子邮件 | 字符串 |
|
recaptcha_response | (may be disabled)recaptcha 响应代码进行验证 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功创建 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.2. validateProxyCacheConfig
POST /api/v1/organization/{orgname}/validateproxycache
运行 POST /api/v1/organization/{orgname}/validateproxycache 目前会返回 202 响应有效负载 Valid。这是个已知问题。它应该返回 Successful Creation 响应有效负载。以后的 Red Hat Quay 版本中会解决这个问题。
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 字符串 |
请求正文模式(application/json)
机构的代理缓存配置
| 名称 | 描述 | 模式 |
|---|---|---|
|
upstream_registry | 要缓存的上游 registry 的名称 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功创建 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.3. getOrganizationCollaborators
列出指定机构外协作器。
GET /api/v1/organization/{orgname}/collaborators
Authorizations: oauth2_implicit(org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.4. getOrganizationApplication
使用指定的 client_id 在指定的机构下检索应用程序。
GET /api/v1/organization/{orgname}/applications/{client_id}
Authorizations: oauth2_implicit(org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
| path |
client_id | OAuth 客户端 ID | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.5. deleteOrganizationApplication
删除此机构下的应用程序。
DELETE /api/v1/organization/{orgname}/applications/{client_id}
Authorizations: oauth2_implicit(org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
| path |
client_id | OAuth 客户端 ID | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 204 | 已删除 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.6. updateOrganizationApplication
更新此机构下的应用程序。
PUT /api/v1/organization/{orgname}/applications/{client_id}
Authorizations: oauth2_implicit(org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
| path |
client_id | OAuth 客户端 ID | 字符串 |
请求正文模式(application/json)
更新应用程序的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
name | 应用程序的名称 | 字符串 |
|
redirect_uri | 应用程序的 OAuth 重定向的 URI | 字符串 |
|
application_uri | 应用程序主页的 URI | 字符串 |
|
description | 应用程序的人类可读描述 | 字符串 |
|
avatar_email | 用于应用程序的 avatar 的电子邮件地址 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.7. getOrganizationApplications
列出指定机构的应用程序。
GET /api/v1/organization/{orgname}/applications
Authorizations: oauth2_implicit(org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.8. createOrganizationApplication
在此组织下创建新应用。
POST /api/v1/organization/{orgname}/applications
Authorizations: oauth2_implicit(org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
请求正文模式(application/json)
新机构应用程序的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
name | 应用程序的名称 | 字符串 |
|
redirect_uri | 应用程序的 OAuth 重定向的 URI | 字符串 |
|
application_uri | 应用程序主页的 URI | 字符串 |
|
description | 应用程序的人类可读描述 | 字符串 |
|
avatar_email | 用于应用程序的 avatar 的电子邮件地址 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功创建 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.9. getProxyCacheConfig
检索机构的代理缓存配置。
GET /api/v1/organization/{orgname}/proxycache
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.10. deleteProxyCacheConfig
删除机构的代理缓存配置。
DELETE /api/v1/organization/{orgname}/proxycache
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 204 | 已删除 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.11. createProxyCacheConfig
为组织创建代理缓存配置。
POST /api/v1/organization/{orgname}/proxycache
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
请求正文模式(application/json)
机构的代理缓存配置
| 名称 | 描述 | 模式 |
|---|---|---|
|
upstream_registry | 要缓存的上游 registry 的名称 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功创建 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.12. removeOrganizationMember
从组织中删除成员，撤销其所有存储库功能，并从机构中的所有团队中删除它。
DELETE /api/v1/organization/{orgname}/members/{membername}
Authorizations: oauth2_implicit(org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
| path |
memberName | 机构成员的用户名 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 204 | 已删除 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.13. getOrganizationMember
检索组织成员的详细信息。
GET /api/v1/organization/{orgname}/members/{membername}
Authorizations: oauth2_implicit(org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
| path |
memberName | 机构成员的用户名 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.14. getOrganizationMembers
列出指定机构的人类。
GET /api/v1/organization/{orgname}/members
Authorizations: oauth2_implicit(org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.15. getOrganization
获取指定机构的详情。
GET /api/v1/organization/{orgname}
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.16. deleteAdminedOrganization
删除指定的机构。
DELETE /api/v1/organization/{orgname}
Authorizations: oauth2_implicit(org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 204 | 已删除 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.17. changeOrganizationDetails
更改指定机构的详情。
PUT /api/v1/organization/{orgname}
Authorizations: oauth2_implicit(org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
请求正文模式(application/json)
现有机构的更新描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
email | 机构联系电子邮件 | 字符串 |
|
invoice_email | 无论组织是否需要接收发票的电子邮件 | 布尔值 |
|
invoice_email_address | 接收发票的电子邮件地址 | |
|
tag_expiration_s | 标签过期的秒数 | 整数 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.11.18. getApplicationInformation
获取指定应用程序的信息。
GET /api/v1/app/{client_id}
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
client_id | OAuth 客户端 ID | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 必需的会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
