Red Hat Summit2.21. superuser
スーパーユーザー API。
2.21.1. createInstallUser
新しいユーザーを作成します。
POST /api/v1/superuser/users/
認可: oauth2_implicit(super:user)
要求の body スキーマ (application/json)
ユーザー作成のデータ
| 名前 | 説明 | スキーマ |
|---|---|---|
|
username | 作成されるユーザーの名前 | string |
|
email | 作成中のユーザーのメールアドレス | 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 '{
"username": "newuser",
"email": "newuser@example.com"
}' "https://<quay-server.example.com>/api/v1/superuser/users/"2.21.2. deleteInstallUser
ユーザーを削除します。
DELETE /api/v1/superuser/users/{username}
認可: oauth2_implicit(super:user)
要求の body スキーマ (application/json)
ユーザーを削除するためのデータ
| Name | 説明 | スキーマ |
|---|---|---|
|
username | 削除するユーザーのユーザー名 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成に成功 | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
コマンドの例
curl -X DELETE -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/users/{username}"
$ curl -X DELETE -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/users/{username}"2.21.3. listAllUsers
システム内の全ユーザーリストを返します。
GET /api/v1/superuser/users/
認可: oauth2_implicit(super:user)
クエリーパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| query |
next_page | 次のページのページトークン | string |
| query |
limit | ページごとに返す結果の数を制限します。最大 100 です。 | integer |
| query |
disabled | false の場合には、有効なユーザーのみが返されます。 | boolean |
応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
コマンドの例
curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/users/"
$ curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/users/"2.21.4. listAllLogs
現在のシステムの使用状況ログをリスト表示します。
GET /api/v1/superuser/logs
認可: oauth2_implicit(super:user)
クエリーパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| query |
next_page | 次のページのページトークン | string |
| query |
page | ログのページ番号 | integer |
| query |
endtime | 最後にログを取得した時間 (%m/%d/%Y %Z) | string |
| query |
starttime | 最初にログを取得する時間 (%m/%d/%Y %Z) | string |
レスポンス
2.21.5. listAllOrganizations
現在のシステムの組織をリスト表示します。
GET /api/v1/superuser/organizations
認可: oauth2_implicit(super:user)
クエリーパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
name | 管理対象の組織名 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
コマンドの例
curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/organizations/"
$ curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/organizations/"2.21.6. createServiceKey
POST /api/v1/superuser/keys
認可: oauth2_implicit(super:user)
要求の body スキーマ (application/json)
サービスキーの作成の説明
| 名前 | 説明 | スキーマ |
|---|---|---|
|
サービス | このキーで認証されるサービス | string |
|
name | サービスキーの判別しやすい名前 | string |
|
metadata | このキーのメタデータのキー/値のペア | object |
|
notes | 指定すると、キーにメモを追加で指定できます。 | string |
|
有効期限 | unix タイムスタンプとしての有効期限 |
応答
2.21.7. listServiceKeys
GET /api/v1/superuser/keys
認可: oauth2_implicit(super:user)
応答
2.21.8. changeUserQuotaSuperUser
PUT /api/v1/superuser/organization/{namespace}/quota/{quota_id}
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
namespace | string | |
| path |
quota_id | string |
要求の body スキーマ (application/json)
新しい組織の割り当ての説明
| 名前 | 説明 | スキーマ |
|---|---|---|
|
limit_bytes | 組織で許可されているバイト数 | integer |
レスポンス
2.21.9. deleteUserQuotaSuperUser
DELETE /api/v1/superuser/organization/{namespace}/quota/{quota_id}
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
namespace | string | |
| path |
quota_id | string |
レスポンス
2.21.10. createUserQuotaSuperUser
POST /api/v1/superuser/organization/{namespace}/quota
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
namespace | string |
要求の body スキーマ (application/json)
新しい組織の割り当ての説明
| 名前 | 説明 | スキーマ |
|---|---|---|
|
limit_bytes | 組織で許可されているバイト数 | integer |
レスポンス
2.21.11. listUserQuotaSuperUser
GET /api/v1/superuser/organization/{namespace}/quota
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
namespace | string |
レスポンス
2.21.12. changeOrganizationQuotaSuperUser
PUT /api/v1/superuser/users/{namespace}/quota/{quota_id}
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
namespace | string | |
| path |
quota_id | string |
要求の body スキーマ (application/json)
新しい組織の割り当ての説明
| 名前 | 説明 | スキーマ |
|---|---|---|
|
limit_bytes | 組織で許可されているバイト数 | integer |
レスポンス
2.21.13. deleteOrganizationQuotaSuperUser
DELETE /api/v1/superuser/users/{namespace}/quota/{quota_id}
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
namespace | string | |
| path |
quota_id | string |
レスポンス
2.21.14. createOrganizationQuotaSuperUser
POST /api/v1/superuser/users/{namespace}/quota
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
namespace | string |
要求の body スキーマ (application/json)
新しい組織の割り当ての説明
| 名前 | 説明 | スキーマ |
|---|---|---|
|
limit_bytes | 組織で許可されているバイト数 | integer |
レスポンス
2.21.15. listOrganizationQuotaSuperUser
GET /api/v1/superuser/users/{namespace}/quota
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
namespace | string |
レスポンス
2.21.16. changeOrganization
指定したユーザーの情報を更新します。
PUT /api/v1/superuser/organizations/{name}
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
name | 管理する組織の名前 | string |
要求の body スキーマ (application/json)
既存組織の更新の説明
| 名前 | 説明 | スキーマ |
|---|---|---|
|
email | 組織の連絡先メール | string |
|
invoice_email | 組織が請求書のメールを受信する必要があるかどうか。 | boolean |
|
invoice_email_address | 請求書を受信するメールアドレス | |
|
tag_expiration_s | タグの有効期限 (秒) | integer |
レスポンス
2.21.17. deleteOrganization
指定した組織を削除します。
DELETE /api/v1/superuser/organizations/{name}
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
name | 管理する組織の名前 | string |
レスポンス
2.21.18. approveServiceKey
POST /api/v1/superuser/approvedkeys/{kid}
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
kid | サービスキーの一意識別子 | string |
要求の body スキーマ (application/json)
サービスキーの承認に関する情報
| 名前 | 説明 | スキーマ |
|---|---|---|
|
notes | オプションの承認に関する注意事項 | string |
レスポンス
2.21.19. deleteServiceKey
DELETE /api/v1/superuser/keys/{kid}
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
kid | サービスキーの一意識別子 | string |
レスポンス
2.21.20. updateServiceKey
PUT /api/v1/superuser/keys/{kid}
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
kid | サービスキーの一意識別子 | string |
要求の body スキーマ (application/json)
サービスキーの更新の説明
| 名前 | 説明 | スキーマ |
|---|---|---|
|
name | サービスキーの判別しやすい名前 | string |
|
metadata | このキーのメタデータのキー/値のペア | object |
|
expiration | unix タイムスタンプとしての有効期限 |
応答
2.21.21. getServiceKey
GET /api/v1/superuser/keys/{kid}
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
kid | サービスキーの一意識別子 | string |
レスポンス
2.21.22. getRepoBuildStatusSuperUser
ビルドの uuid で指定したビルドのステータスを返します。
GET /api/v1/superuser/{build_uuid}/status
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
build_uuid | ビルドの UUID | string |
レスポンス
2.21.23. getRepoBuildSuperUser
ビルドに関する情報を返します。
GET /api/v1/superuser/{build_uuid}/build
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
build_uuid | ビルドの UUID | string |
レスポンス
2.21.24. getRepoBuildLogsSuperUser
ビルド uuid で指定したビルドのビルドログを返します。
GET /api/v1/superuser/{build_uuid}/logs
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
build_uuid | ビルドの UUID | string |
レスポンス
2.21.25. getRegistrySize
GET /api/v1/superuser/registrysize/
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
namespace | string |
イメージレジストリーサイズの説明
| Name | 説明 | スキーマ |
|---|---|---|
|
size_bytes* | 組織で許可されているバイト数 | integer |
| last_ran | integer | |
| queued | boolean | |
| running | boolean |
応答
2.21.26. postRegistrySize
POST /api/v1/superuser/registrysize/
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
namespace | string |
要求の body スキーマ (application/json)
イメージレジストリーサイズの説明
| Name | 説明 | スキーマ |
|---|---|---|
| last_ran | integer | |
| queued | boolean | |
| running | boolean |
'%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}