红帽全球峰会2.11. 机构
管理机构、成员和 OAuth 应用。
2.11.1. createOrganization
创建新组织。
POST /api/v1/organization/
授权： oauth2_implicit (user:admin)
请求正文架构(application/json)
新组织的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
name | 机构用户名 | 字符串 |
|
email | 机构联系电子邮件 | 字符串 |
|
recaptcha_response | (may 被禁用) recaptcha 响应代码进行验证 | 字符串 |
响应
2.11.2. validateProxyCacheConfig
POST /api/v1/organization/{orgname}/validateproxycache
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 字符串 |
请求正文架构(application/json)
机构的代理缓存配置
| 名称 | 描述 | 模式 |
|---|---|---|
|
upstream_registry | 要缓存的上游 registry 的名称 | 字符串 |
响应
2.11.3. getOrganizationCollaborators
列出指定机构的外部协作者。
GET /api/v1/organization/{orgname}/collaborators
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
2.11.4. getOrganizationApplication
使用指定组织下的指定 client_id 检索应用。
GET /api/v1/organization/{orgname}/applications/{client_id}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
client_id | OAuth 客户端 ID | 字符串 |
| path |
OrgName | 机构名称 | 字符串 |
响应
2.11.5. updateOrganizationApplication
更新此机构下的应用程序。
PUT /api/v1/organization/{orgname}/applications/{client_id}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
client_id | OAuth 客户端 ID | 字符串 |
| path |
OrgName | 机构名称 | 字符串 |
请求正文架构(application/json)
更新的应用程序的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
name | 应用程序的名称 | 字符串 |
|
redirect_uri | 应用的 OAuth 重定向的 URI | 字符串 |
|
application_uri | 应用程序主页的 URI | 字符串 |
|
description | 应用程序的人类可读描述 | 字符串 |
|
avatar_email | 用于应用程序的 avatar 的电子邮件地址 | 字符串 |
响应
2.11.6. deleteOrganizationApplication
删除此机构下的应用程序。
DELETE /api/v1/organization/{orgname}/applications/{client_id}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
client_id | OAuth 客户端 ID | 字符串 |
| path |
OrgName | 机构名称 | 字符串 |
响应
2.11.7. createOrganizationApplication
在此机构中创建新应用。
POST /api/v1/organization/{orgname}/applications
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
请求正文架构(application/json)
新机构应用程序的描述。
| 名称 | 描述 | 模式 |
|---|---|---|
|
name | 应用程序的名称 | 字符串 |
|
redirect_uri | 应用的 OAuth 重定向的 URI | 字符串 |
|
application_uri | 应用程序主页的 URI | 字符串 |
|
description | 应用程序的人类可读描述 | 字符串 |
|
avatar_email | 用于应用程序的 avatar 的电子邮件地址 | 字符串 |
响应
2.11.8. getOrganizationApplications
列出指定机构的应用程序。
GET /api/v1/organization/{orgname}/applications
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
2.11.9. getProxyCacheConfig
检索组织的代理缓存配置。
GET /api/v1/organization/{orgname}/proxycache
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
2.11.10. deleteProxyCacheConfig
删除机构的代理缓存配置。
DELETE /api/v1/organization/{orgname}/proxycache
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
2.11.11. createProxyCacheConfig
为机构创建代理缓存配置。
POST /api/v1/organization/{orgname}/proxycache
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
请求正文架构(application/json)
机构的代理缓存配置
| 名称 | 描述 | 模式 |
|---|---|---|
|
upstream_registry | 要缓存的上游 registry 的名称 | 字符串 |
响应
2.11.12. getOrganizationMember
检索组织成员的详细信息。
GET /api/v1/organization/{orgname}/members/{membername}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
memberName | 机构成员的用户名 | 字符串 |
| path |
OrgName | 机构名称 | 字符串 |
响应
2.11.13. removeOrganizationMember
从机构中删除成员，撤销所有存储库特权，并将它从组织中的所有团队中删除。
DELETE /api/v1/organization/{orgname}/members/{membername}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
memberName | 机构成员的用户名 | 字符串 |
| path |
OrgName | 机构名称 | 字符串 |
响应
2.11.14. getOrganizationMembers
列出指定机构的人员。
GET /api/v1/organization/{orgname}/members
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
2.11.15. getOrganization
获取指定机构的详情。
GET /api/v1/organization/{orgname}
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
2.11.16. changeOrganizationDetails
更改指定机构的详情。
PUT /api/v1/organization/{orgname}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
请求正文架构(application/json)
现有机构的更新描述
| 名称 | 描述 | 模式 |
|---|---|---|
|
email | 机构联系电子邮件 | 字符串 |
|
invoice_email | 组织是否希望接收发票的电子邮件 | 布尔值 |
|
invoice_email_address | 接收发票的电子邮件地址 | |
|
tag_expiration_s | 标签过期的秒数 | 整数 |
响应
2.11.17. deleteAdminedOrganization
删除指定的机构。
DELETE /api/v1/organization/{orgname}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
响应
2.11.18. getApplicationInformation
获取指定应用程序的信息。
GET /api/v1/app/{client_id}
授权：
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
client_id | OAuth 客户端 ID | 字符串 |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}