7.11. organization
組織、メンバーおよび OAuth アプリケーションを管理します。
7.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 (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X POST -H "Authorization: Bearer <bearer_token>" -H "Content-Type: application/json" -d '{
$ 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/"
7.11.2. validateProxyCacheConfig リンクのコピーリンクがクリップボードにコピーされました!
POST /api/v1/organization/{orgname}/validateproxycache
認可:
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
orgname | string |
要求の body スキーマ (application/json)
組織のプロキシーキャッシュ設定
名前 | 説明 | スキーマ |
---|---|---|
upstream_registry | キャッシュされるアップストリームレジストリーの名前 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 作成に成功 | |
400 | Bad Request (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
7.11.3. getOrganizationCollaborators リンクのコピーリンクがクリップボードにコピーされました!
指定した組織の外部コラボレーターをリスト表示します。
GET /api/v1/organization/{orgname}/collaborators
認可: oauth2_implicit(org:admin)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
orgname | 組織の名前 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | Bad Request (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X GET "https://<quay-server.example.com>/api/v1/organization/{orgname}/collaborators" \ -H "Authorization: Bearer <access_token>"
$ curl -X GET "https://<quay-server.example.com>/api/v1/organization/{orgname}/collaborators" \
-H "Authorization: Bearer <access_token>"
7.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 (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/applications/<client_id>" \ -H "Authorization: Bearer <access_token>"
$ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/applications/<client_id>" \
-H "Authorization: Bearer <access_token>"
7.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 (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
7.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 (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/{orgname}/applications/{client_id}" \ -H "Authorization: Bearer <access_token>"
$ curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/{orgname}/applications/{client_id}" \
-H "Authorization: Bearer <access_token>"
7.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 (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
7.11.8. getOrganizationApplications リンクのコピーリンクがクリップボードにコピーされました!
指定した組織のアプリケーションをリスト表示します。
GET /api/v1/organization/{orgname}/applications
認可: oauth2_implicit(org:admin)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
orgname | 組織の名前 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | Bad Request (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/applications" \ -H "Authorization: Bearer <access_token>"
$ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/applications" \
-H "Authorization: Bearer <access_token>"
7.11.9. getProxyCacheConfig リンクのコピーリンクがクリップボードにコピーされました!
組織のプロキシーキャッシュ設定を取得します。
GET /api/v1/organization/{orgname}/proxycache
認可:
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
orgname | 組織の名前 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | Bad Request (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X GET "https://<quay-server.example.com>/api/v1/organization/{orgname}/proxycache" \ -H "Authorization: Bearer <access_token>"
$ curl -X GET "https://<quay-server.example.com>/api/v1/organization/{orgname}/proxycache" \
-H "Authorization: Bearer <access_token>"
7.11.10. deleteProxyCacheConfig リンクのコピーリンクがクリップボードにコピーされました!
組織のプロキシーキャッシュ設定を削除します。
DELETE /api/v1/organization/{orgname}/proxycache
認可:
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
orgname | 組織の名前 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
204 | 削除済み | |
400 | Bad Request (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/{orgname}/proxycache" \ -H "Authorization: Bearer <access_token>"
$ curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/{orgname}/proxycache" \
-H "Authorization: Bearer <access_token>"
7.11.11. createProxyCacheConfig リンクのコピーリンクがクリップボードにコピーされました!
組織のプロキシーキャッシュ設定を作成します。
POST /api/v1/organization/{orgname}/proxycache
認可:
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
orgname | 組織の名前 | string |
要求の body スキーマ (application/json)
組織のプロキシーキャッシュ設定
名前 | 説明 | スキーマ |
---|---|---|
upstream_registry | キャッシュされるアップストリームレジストリーの名前 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
201 | 作成に成功 | |
400 | Bad Request (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
7.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 (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/members/<membername>" \ -H "Authorization: Bearer <access_token>"
$ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/members/<membername>" \
-H "Authorization: Bearer <access_token>"
7.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 (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/<orgname>/members/<membername>" \ -H "Authorization: Bearer <access_token>"
$ curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/<orgname>/members/<membername>" \
-H "Authorization: Bearer <access_token>"
7.11.14. getOrganizationMembers リンクのコピーリンクがクリップボードにコピーされました!
指定した組織のメンバー (人間) をリスト表示します。
GET /api/v1/organization/{orgname}/members
認可: oauth2_implicit(org:admin)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
orgname | 組織の名前 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | Bad Request (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/members" \ -H "Authorization: Bearer <access_token>"
$ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/members" \
-H "Authorization: Bearer <access_token>"
7.11.15. getOrganization リンクのコピーリンクがクリップボードにコピーされました!
指定した組織の詳細を取得します。
GET /api/v1/organization/{orgname}
認可:
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
orgname | 組織の名前 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | Bad Request (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X GET \ -H "Authorization: Bearer <bearer_token>" \ "<quay-server.example.com>/api/v1/organization/<organization_name>"
$ curl -X GET \
-H "Authorization: Bearer <bearer_token>" \
"<quay-server.example.com>/api/v1/organization/<organization_name>"
7.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 (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X PUT \ -H "Authorization: Bearer <bearer_token>" \ "<quay-server.example.com>/api/v1/organization/<organization_name>"
$ curl -X PUT \
-H "Authorization: Bearer <bearer_token>" \
"<quay-server.example.com>/api/v1/organization/<organization_name>"
7.11.17. deleteAdminedOrganization リンクのコピーリンクがクリップボードにコピーされました!
指定した組織を削除します。
DELETE /api/v1/organization/{orgname}
認可: oauth2_implicit(org:admin)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
orgname | 組織の名前 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
204 | 削除済み | |
400 | Bad Request (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X GET \ -H "Authorization: Bearer <bearer_token>" \ "<quay-server.example.com>/api/v1/organization/<organization_name>"
$ curl -X GET \
-H "Authorization: Bearer <bearer_token>" \
"<quay-server.example.com>/api/v1/organization/<organization_name>"
7.11.18. getApplicationInformation リンクのコピーリンクがクリップボードにコピーされました!
指定したアプリケーションに関する情報を取得します。
GET /api/v1/app/{client_id}
認可:
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
client_id | OAuth クライアント ID | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | Bad Request (不適切な要求) | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
コマンドの例
curl -X GET "https://<quay-server.example.com>/api/v1/app/<client_id>" \ -H "Authorization: Bearer <access_token>"
$ curl -X GET "https://<quay-server.example.com>/api/v1/app/<client_id>" \
-H "Authorization: Bearer <access_token>"