2.11. 組織
組織、メンバーおよび OAuth アプリケーションを管理します。
2.11.1. createOrganization
新しい組織を作成します。
POST /api/v1/organization/
承認: oauth2_implicit(user:admin)
要求のボディースキーマ (アプリケーション/json)
新しい組織の説明。
| 名前 | 説明 | スキーマ |
|---|---|---|
|
name | 組織のユーザー名 | string |
|
email | 組織の連絡先メール | string |
|
recaptcha_response | 検証用の recaptcha 応答コード (無効となっている場合もある)。 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成成功 | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.2. validateProxyCacheConfig
POST /api/v1/organization/{orgname}/validateproxycache
POST/api/v1/organization/{orgname}/validateproxycache を実行すると、現在、Valid の 202 応答ペイロードが返されます。これは既知の問題です。Successful Creation 応答ペイロードを返すはずです。これは、Red Hat Quay の将来のバージョンで修正される予定です。
承認:
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | string |
要求のボディースキーマ (アプリケーション/json)
組織のプロキシーキャッシュ設定
| 名前 | 説明 | スキーマ |
|---|---|---|
|
upstream_registry | キャッシュされるアップストリームレジストリーの名前 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成成功 | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.3. getOrganizationCollaborators
指定した組織の外部コラボレーターを一覧表示します。
GET /api/v1/organization/{orgname}/collaborators
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.4. getOrganizationApplication
指定の組織、指定の client_id のアプリケーションを取得します。
GET /api/v1/organization/{orgname}/applications/{client_id}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
| path |
client_id | OAuth クライアント ID | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.5. deleteOrganizationApplication
この組織のアプリケーションを削除します。
DELETE /api/v1/organization/{orgname}/applications/{client_id}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
| path |
client_id | OAuth クライアント ID | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 204 | 削除済み | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.6. updateOrganizationApplication
この組織のアプリケーションを更新します。
PUT /api/v1/organization/{orgname}/applications/{client_id}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
| path |
client_id | OAuth クライアント ID | string |
要求のボディースキーマ (アプリケーション/json)
更新アプリケーションの説明。
| 名前 | 説明 | スキーマ |
|---|---|---|
|
name | アプリケーションの名前 | string |
|
redirect_uri | アプリケーションの OAuth リダイレクトの URI | string |
|
application_uri | アプリケーションのホームページの URI | string |
|
description | アプリケーションの人間が判読できる説明 | string |
|
avatar_email | アプリケーションに使用するアバターのメールアドレス | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.7. getOrganizationApplications
指定した組織のアプリケーションを一覧表示します。
GET /api/v1/organization/{orgname}/applications
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.8. createOrganizationApplication
この組織に新しいアプリケーションを作成します。
POST /api/v1/organization/{orgname}/applications
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
要求のボディースキーマ (アプリケーション/json)
新しい組織アプリケーションを説明します。
| 名前 | 説明 | スキーマ |
|---|---|---|
|
name | アプリケーションの名前 | string |
|
redirect_uri | アプリケーションの OAuth リダイレクトの URI | string |
|
application_uri | アプリケーションのホームページの URI | string |
|
description | アプリケーションの人間が判読できる説明 | string |
|
avatar_email | アプリケーションに使用するアバターのメールアドレス | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成成功 | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.9. getProxyCacheConfig
組織のプロキシーキャッシュ設定を取得します。
GET /api/v1/organization/{orgname}/proxycache
承認:
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.10. deleteProxyCacheConfig
組織のプロキシーキャッシュ設定を削除します。
DELETE /api/v1/organization/{orgname}/proxycache
承認:
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 204 | 削除済み | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.11. createProxyCacheConfig
組織のプロキシーキャッシュ設定を作成します。
POST /api/v1/organization/{orgname}/proxycache
承認:
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
要求のボディースキーマ (アプリケーション/json)
組織のプロキシーキャッシュ設定
| 名前 | 説明 | スキーマ |
|---|---|---|
|
upstream_registry | キャッシュされるアップストリームレジストリーの名前 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成成功 | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.12. removeOrganizationMember
組織からメンバーを削除し、そのリポジトリーの特権をすべて破棄して組織の全チームから削除します。
DELETE /api/v1/organization/{orgname}/members/{membername}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
| path |
membername | 組織メンバーのユーザー名 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 204 | 削除済み | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.13. getOrganizationMember
組織のメンバーの詳細を取得します。
GET /api/v1/organization/{orgname}/members/{membername}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
| path |
membername | 組織メンバーのユーザー名 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.14. getOrganizationMembers
指定した組織のメンバー (人間) を一覧表示します。
GET /api/v1/organization/{orgname}/members
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.15. getOrganization
指定した組織の詳細を取得します。
GET /api/v1/organization/{orgname}
承認:
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.16. deleteAdminedOrganization
指定した組織を削除します。
DELETE /api/v1/organization/{orgname}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 204 | 削除済み | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.17. changeOrganizationDetails
指定した組織の詳細を変更します。
PUT /api/v1/organization/{orgname}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
要求のボディースキーマ (アプリケーション/json)
既存組織の更新の説明
| 名前 | 説明 | スキーマ |
|---|---|---|
|
email | 組織の連絡先メール | string |
|
invoice_email | 組織が請求書のメールを受信する必要があるかどうか | boolean |
|
invoice_email_address | 請求書を受信するメールアドレス | |
|
tag_expiration_s | タグの有効期限 (秒) | 整数 |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.11.18. getApplicationInformation
指定したアプリケーションに関する情報を取得します。
GET /api/v1/app/{client_id}
承認:
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
client_id | OAuth クライアント ID | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
