Red Hat Summit2.11. 組織
組織、メンバーおよび OAuth アプリケーションを管理します。
2.11.1. createOrganization
新しい組織を作成します。
POST /api/v1/organization/
承認: oauth2_implicit(user:admin)
要求の body スキーマ (application/json)
新しい組織の説明。
| 名前 | Description | スキーマ |
|---|---|---|
|
name | 組織のユーザー名 | string |
|
email | 組織の連絡先メール | string |
|
recaptcha_response | 検証用の recaptcha 応答コード (無効となっている場合もある)。 | string |
レスポンス
2.11.2. validateProxyCacheConfig
POST /api/v1/organization/{orgname}/validateproxycache
承認:
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
orgname | string |
要求の body スキーマ (application/json)
組織のプロキシーキャッシュ設定
| 名前 | Description | スキーマ |
|---|---|---|
|
upstream_registry | キャッシュされるアップストリームレジストリーの名前 | string |
レスポンス
2.11.3. getOrganizationCollaborators
指定した組織の外部コラボレーターをリスト表示します。
GET /api/v1/organization/{orgname}/collaborators
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
2.11.4. getOrganizationApplication
指定の組織、指定の client_id のアプリケーションを取得します。
GET /api/v1/organization/{orgname}/applications/{client_id}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
client_id | OAuth クライアント ID | string |
| path |
orgname | 組織の名前 | string |
レスポンス
2.11.5. updateOrganizationApplication
この組織のアプリケーションを更新します。
PUT /api/v1/organization/{orgname}/applications/{client_id}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
client_id | OAuth クライアント ID | string |
| path |
orgname | 組織の名前 | string |
要求の body スキーマ (application/json)
更新アプリケーションの説明。
| 名前 | Description | スキーマ |
|---|---|---|
|
name | アプリケーションの名前 | string |
|
redirect_uri | アプリケーションの OAuth リダイレクトの URI | string |
|
application_uri | アプリケーションのホームページの URI | string |
|
description | アプリケーションの人間が判読できる説明 | string |
|
avatar_email | アプリケーションに使用するアバターのメールアドレス | string |
レスポンス
2.11.6. deleteOrganizationApplication
この組織のアプリケーションを削除します。
DELETE /api/v1/organization/{orgname}/applications/{client_id}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
client_id | OAuth クライアント ID | string |
| path |
orgname | 組織の名前 | string |
レスポンス
2.11.7. createOrganizationApplication
この組織に新しいアプリケーションを作成します。
POST /api/v1/organization/{orgname}/applications
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
要求の body スキーマ (application/json)
新しい組織アプリケーションを説明します。
| 名前 | Description | スキーマ |
|---|---|---|
|
name | アプリケーションの名前 | string |
|
redirect_uri | アプリケーションの OAuth リダイレクトの URI | string |
|
application_uri | アプリケーションのホームページの URI | string |
|
description | アプリケーションの人間が判読できる説明 | string |
|
avatar_email | アプリケーションに使用するアバターのメールアドレス | string |
レスポンス
2.11.8. getOrganizationApplications
指定した組織のアプリケーションをリスト表示します。
GET /api/v1/organization/{orgname}/applications
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
2.11.9. getProxyCacheConfig
組織のプロキシーキャッシュ設定を取得します。
GET /api/v1/organization/{orgname}/proxycache
承認:
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
2.11.10. deleteProxyCacheConfig
組織のプロキシーキャッシュ設定を削除します。
DELETE /api/v1/organization/{orgname}/proxycache
承認:
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
2.11.11. createProxyCacheConfig
組織のプロキシーキャッシュ設定を作成します。
POST /api/v1/organization/{orgname}/proxycache
承認:
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
要求の body スキーマ (application/json)
組織のプロキシーキャッシュ設定
| 名前 | Description | スキーマ |
|---|---|---|
|
upstream_registry | キャッシュされるアップストリームレジストリーの名前 | string |
レスポンス
2.11.12. getOrganizationMember
組織のメンバーの詳細を取得します。
GET /api/v1/organization/{orgname}/members/{membername}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
membername | 組織メンバーのユーザー名 | string |
| path |
orgname | 組織の名前 | string |
レスポンス
2.11.13. removeOrganizationMember
組織からメンバーを削除し、そのリポジトリーの特権をすべて破棄して組織の全チームから削除します。
DELETE /api/v1/organization/{orgname}/members/{membername}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
membername | 組織メンバーのユーザー名 | string |
| path |
orgname | 組織の名前 | string |
レスポンス
2.11.14. getOrganizationMembers
指定した組織のメンバー (人間) をリスト表示します。
GET /api/v1/organization/{orgname}/members
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
2.11.15. getOrganization
指定した組織の詳細を取得します。
GET /api/v1/organization/{orgname}
承認:
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
2.11.16. changeOrganizationDetails
指定した組織の詳細を変更します。
PUT /api/v1/organization/{orgname}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
要求の body スキーマ (application/json)
既存組織の更新の説明
| 名前 | Description | スキーマ |
|---|---|---|
|
email | 組織の連絡先メール | string |
|
invoice_email | 組織が請求書のメールを受信する必要があるかどうか | boolean |
|
invoice_email_address | 請求書を受信するメールアドレス | |
|
tag_expiration_s | タグの有効期限 (秒) | integer |
応答
2.11.17. deleteAdminedOrganization
指定した組織を削除します。
DELETE /api/v1/organization/{orgname}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
2.11.18. getApplicationInformation
指定したアプリケーションに関する情報を取得します。
GET /api/v1/app/{client_id}
承認:
パスパラメーター
| タイプ | Name | Description | スキーマ |
|---|---|---|---|
| path |
client_id | OAuth クライアント ID | string |
'%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}