3.11. organization | Red Hat Product Documentation

3.11.1. createOrganization

新しい組織を作成します。

POST /api/v1/organization/

認可: oauth2_implicit (user:admin)

要求の body スキーマ (application/json)

新しい組織の説明。

名前	説明	スキーマ
name 必須	組織のユーザー名	string
email 任意	組織の連絡先メール	string
recaptcha_response 任意	検証用の recaptcha 応答コード (無効となっている場合もある)。	string

レスポンス

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	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/"

3.11.2. validateProxyCacheConfig

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

認可:

パスパラメーター

タイプ	名前	説明	スキーマ
path	orgname 必須		string

要求の body スキーマ (application/json)

組織のプロキシーキャッシュ設定

名前	説明	スキーマ
upstream_registry 必須	キャッシュされるアップストリームレジストリーの名前	string

レスポンス

HTTP コード	説明	スキーマ
202	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.3. getOrganizationCollaborators

指定した組織の外部コラボレーターをリスト表示します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.4. getOrganizationApplication

指定の組織、指定の client_id のアプリケーションを取得します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

タイプ	名前	説明	スキーマ
path	client_id 必須	OAuth クライアント ID	string
path	orgname 必須	組織の名前	string

レスポンス

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.5. updateOrganizationApplication

この組織のアプリケーションを更新します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

タイプ	名前	説明	スキーマ
path	client_id 必須	OAuth クライアント ID	string
path	orgname 必須	組織の名前	string

要求の body スキーマ (application/json)

更新アプリケーションの説明。

名前	説明	スキーマ
name 必須	アプリケーションの名前	string
redirect_uri 必須	アプリケーションの OAuth リダイレクトの URI	string
application_uri 必須	アプリケーションのホームページの URI	string
description 任意	アプリケーションの人間が判読できる説明	string
avatar_email 任意	アプリケーションに使用するアバターのメールアドレス	string

レスポンス

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.6. deleteOrganizationApplication

この組織のアプリケーションを削除します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

タイプ	名前	説明	スキーマ
path	client_id 必須	OAuth クライアント ID	string
path	orgname 必須	組織の名前	string

レスポンス

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.7. createOrganizationApplication

この組織に新しいアプリケーションを作成します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

要求の body スキーマ (application/json)

新しい組織アプリケーションを説明します。

名前	説明	スキーマ
name 必須	アプリケーションの名前	string
redirect_uri 任意	アプリケーションの OAuth リダイレクトの URI	string
application_uri 任意	アプリケーションのホームページの URI	string
description 任意	アプリケーションの人間が判読できる説明	string
avatar_email 任意	アプリケーションに使用するアバターのメールアドレス	string

レスポンス

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.8. getOrganizationApplications

指定した組織のアプリケーションをリスト表示します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.9. getProxyCacheConfig

組織のプロキシーキャッシュ設定を取得します。

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

認可:

パスパラメーター

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.10. deleteProxyCacheConfig

組織のプロキシーキャッシュ設定を削除します。

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

認可:

パスパラメーター

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.11. createProxyCacheConfig

組織のプロキシーキャッシュ設定を作成します。

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

認可:

パスパラメーター

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

要求の body スキーマ (application/json)

組織のプロキシーキャッシュ設定

名前	説明	スキーマ
upstream_registry 必須	キャッシュされるアップストリームレジストリーの名前	string

レスポンス

HTTP コード	説明	スキーマ
201	作成に成功
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.12. getOrganizationMember

組織のメンバーの詳細を取得します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

タイプ	名前	説明	スキーマ
path	membername 必須	組織メンバーのユーザー名	string
path	orgname 必須	組織の名前	string

レスポンス

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.13. removeOrganizationMember

組織からメンバーを削除し、そのリポジトリーの特権をすべて破棄して組織の全チームから削除します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

タイプ	名前	説明	スキーマ
path	membername 必須	組織メンバーのユーザー名	string
path	orgname 必須	組織の名前	string

レスポンス

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.14. getOrganizationMembers

指定した組織のメンバー (人間) をリスト表示します。

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

認可: oauth2_implicit(org:admin)

パスパラメーター

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.15. getOrganization

指定した組織の詳細を取得します。

GET /api/v1/organization/{orgname}

認可:

パスパラメーター

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

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

3.11.16. changeOrganizationDetails

指定した組織の詳細を変更します。

PUT /api/v1/organization/{orgname}

認可: oauth2_implicit(org:admin)

パスパラメーター

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

要求の body スキーマ (application/json)

既存組織の更新の説明

名前	説明	スキーマ
email 任意	組織の連絡先メール	string
invoice_email 任意	組織が請求書のメールを受信する必要があるかどうか。	boolean
invoice_email_address 任意	請求書を受信するメールアドレス
tag_expiration_s 任意	タグの有効期限 (秒)	integer

レスポンス

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

3.11.17. deleteAdminedOrganization

指定した組織を削除します。

DELETE /api/v1/organization/{orgname}

認可: oauth2_implicit(org:admin)

パスパラメーター

タイプ	名前	説明	スキーマ
path	orgname 必須	組織の名前	string

レスポンス

HTTP コード	説明	スキーマ
204	削除済み
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError

コマンドの例

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

3.11.18. getApplicationInformation

指定したアプリケーションに関する情報を取得します。

GET /api/v1/app/{client_id}

認可:

パスパラメーター

タイプ	名前	説明	スキーマ
path	client_id 必須	OAuth クライアント ID	string

レスポンス

HTTP コード	説明	スキーマ
200	正常な呼び出し
400	Bad Request (不適切な要求)	ApiError
401	セッションが必要	ApiError
403	不正アクセス	ApiError
404	結果が見つからない	ApiError