2.11. 机构 | Red Hat Product Documentation

2.11.1. createOrganization

创建新机构。

POST /api/v1/organization/

授权： oauth2_implicit (user:admin)

请求正文模式(application/json)

新组织的描述。

名称	描述	模式
name 必需	机构用户名	字符串
email 可选	机构联系电子邮件	字符串
recaptcha_response optional	（可以禁用）recaptcha 响应代码进行验证	字符串

响应

HTTP 代码	描述	模式
201	成功创建
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

示例命令

$ curl -X POST   -H "Authorization: Bearer <bearer_token>" -H "Content-Type: application/json"   -d '{
    "name": "<new_organization_name>"
  }'   "https://<quay-server.example.com>/api/v1/organization/"

2.11.2. validateProxyCacheConfig

POST /api/v1/organization/{orgname}/validateproxycache

授权：

路径参数

类型	Name	描述	模式
path	需要OrgName		字符串

请求正文模式(application/json)

机构的代理缓存配置

名称	描述	模式
upstream_registry 必需	要缓存的上游 registry 的名称	字符串

响应

HTTP 代码	描述	模式
202	成功创建
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.3. getOrganizationCollaborators

列出指定机构的外部协作者。

GET /api/v1/organization/{orgname}/collaborators

授权： oauth2_implicit (org:admin)

路径参数

类型	Name	描述	模式
path	需要OrgName	机构名称	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.4. getOrganizationApplication

使用指定组织下的指定 client_id 检索应用。

GET /api/v1/organization/{orgname}/applications/{client_id}

授权： oauth2_implicit (org:admin)

路径参数

类型	Name	描述	模式
path	client_id required	OAuth 客户端 ID	字符串
path	需要OrgName	机构名称	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.5. updateOrganizationApplication

更新此机构下的应用程序。

PUT /api/v1/organization/{orgname}/applications/{client_id}

授权： oauth2_implicit (org:admin)

路径参数

类型	Name	描述	模式
path	client_id required	OAuth 客户端 ID	字符串
path	需要OrgName	机构名称	字符串

请求正文模式(application/json)

更新的应用程序的描述。

名称	描述	模式
name 必需	应用程序的名称	字符串
redirect_uri required	应用程序的 OAuth 重定向的 URI	字符串
application_uri required	应用程序主页的 URI	字符串
description 可选	应用程序的人类可读描述	字符串
avatar_email optional	用于应用程序的 avatar 电子邮件地址	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.6. deleteOrganizationApplication

删除此机构下的应用程序。

DELETE /api/v1/organization/{orgname}/applications/{client_id}

授权： oauth2_implicit (org:admin)

路径参数

类型	Name	描述	模式
path	client_id required	OAuth 客户端 ID	字符串
path	需要OrgName	机构名称	字符串

响应

HTTP 代码	描述	模式
204	已删除
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.7. createOrganizationApplication

在此组织下创建新应用。

POST /api/v1/organization/{orgname}/applications

授权： oauth2_implicit (org:admin)

路径参数

类型	Name	描述	模式
path	需要OrgName	机构名称	字符串

请求正文模式(application/json)

新组织应用的描述。

名称	描述	模式
name 必需	应用程序的名称	字符串
redirect_uri optional	应用程序的 OAuth 重定向的 URI	字符串
application_uri optional	应用程序主页的 URI	字符串
description 可选	应用程序的人类可读描述	字符串
avatar_email optional	用于应用程序的 avatar 电子邮件地址	字符串

响应

HTTP 代码	描述	模式
201	成功创建
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.8. getOrganizationApplications

列出指定机构的应用程序。

GET /api/v1/organization/{orgname}/applications

授权： oauth2_implicit (org:admin)

路径参数

类型	Name	描述	模式
path	需要OrgName	机构名称	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.9. getProxyCacheConfig

检索组织的代理缓存配置。

GET /api/v1/organization/{orgname}/proxycache

授权：

路径参数

类型	Name	描述	模式
path	需要OrgName	机构名称	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.10. deleteProxyCacheConfig

删除机构的代理缓存配置。

DELETE /api/v1/organization/{orgname}/proxycache

授权：

路径参数

类型	Name	描述	模式
path	需要OrgName	机构名称	字符串

响应

HTTP 代码	描述	模式
204	已删除
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.11. createProxyCacheConfig

为机构创建代理缓存配置。

POST /api/v1/organization/{orgname}/proxycache

授权：

路径参数

类型	Name	描述	模式
path	需要OrgName	机构名称	字符串

请求正文模式(application/json)

机构的代理缓存配置

名称	描述	模式
upstream_registry 必需	要缓存的上游 registry 的名称	字符串

响应

HTTP 代码	描述	模式
201	成功创建
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.12. getOrganizationMember

检索组织成员的详细信息。

GET /api/v1/organization/{orgname}/members/{membername}

授权： oauth2_implicit (org:admin)

路径参数

类型	Name	描述	模式
path	需要 memberName	机构成员的用户名	string
path	需要OrgName	机构名称	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.13. removeOrganizationMember

从机构中删除成员，撤销其所有存储库的权限，并将其从机构中的所有团队中删除。

DELETE /api/v1/organization/{orgname}/members/{membername}

授权： oauth2_implicit (org:admin)

路径参数

类型	Name	描述	模式
path	需要 memberName	机构成员的用户名	string
path	需要OrgName	机构名称	字符串

响应

HTTP 代码	描述	模式
204	已删除
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.14. getOrganizationMembers

列出指定机构的人员成员。

GET /api/v1/organization/{orgname}/members

授权： oauth2_implicit (org:admin)

路径参数

类型	Name	描述	模式
path	需要OrgName	机构名称	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.15. getOrganization

获取指定机构的详细信息。

GET /api/v1/organization/{orgname}

授权：

路径参数

类型	Name	描述	模式
path	需要OrgName	机构名称	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

示例命令

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>"

2.11.16. changeOrganizationDetails

更改指定机构的详情。

PUT /api/v1/organization/{orgname}

授权： oauth2_implicit (org:admin)

路径参数

类型	Name	描述	模式
path	需要OrgName	机构名称	字符串

请求正文模式(application/json)

现有机构的更新描述

名称	描述	模式
email 可选	机构联系电子邮件	字符串
invoice_email optional	机构是否希望接收发票的电子邮件	布尔值
invoice_email_address optional	要接收发票的电子邮件地址
tag_expiration_s optional	标签过期的秒数	整数

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.11.17. deleteAdminedOrganization

删除指定的机构。

DELETE /api/v1/organization/{orgname}

授权： oauth2_implicit (org:admin)

路径参数

类型	Name	描述	模式
path	需要OrgName	机构名称	字符串

响应

HTTP 代码	描述	模式
204	已删除
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

示例命令

$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>"

2.11.18. getApplicationInformation

获取指定应用程序的信息。

GET /api/v1/app/{client_id}

授权：

路径参数

类型	Name	描述	模式
path	client_id required	OAuth 客户端 ID	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError