2.21. superuser


スーパーユーザー API。

2.21.1. createInstallUser

新しいユーザーを作成します。

POST /api/v1/superuser/users/

認可: oauth2_implicit(super:user)

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

ユーザー作成のデータ

Expand
名前説明スキーマ

username
必須

作成されるユーザーの名前

string

email
任意

作成中のユーザーのメールアドレス

string

レスポンス
Expand
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 '{
  "username": "newuser",
  "email": "newuser@example.com"
}' "https://<quay-server.example.com>/api/v1/superuser/users/"
Copy to Clipboard Toggle word wrap

2.21.2. deleteInstallUser

ユーザーを削除します。

DELETE /api/v1/superuser/users/{username}

認可: oauth2_implicit(super:user)

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

ユーザーを削除するためのデータ

Expand
Name説明スキーマ

username
必須

削除するユーザーのユーザー名

string

レスポンス
Expand
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
$ curl -X DELETE -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/users/{username}"
Copy to Clipboard Toggle word wrap

2.21.3. listAllUsers

システム内の全ユーザーリストを返します。

GET /api/v1/superuser/users/

認可: oauth2_implicit(super:user)

クエリーパラメーター
Expand
タイプ名前説明スキーマ

query

next_page
任意

次のページのページトークン

string

query

limit
任意

ページごとに返す結果の数を制限します。最大 100 です。

integer

query

disabled
任意

false の場合には、有効なユーザーのみが返されます。

boolean

応答
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
$ curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/users/"
Copy to Clipboard Toggle word wrap

2.21.4. listAllLogs

現在のシステムの使用状況ログをリスト表示します。

GET /api/v1/superuser/logs

認可: oauth2_implicit(super:user)

クエリーパラメーター
Expand
タイプ名前説明スキーマ

query

next_page
任意

次のページのページトークン

string

query

page
任意

ログのページ番号

integer

query

endtime
任意

最後にログを取得した時間 (%m/%d/%Y %Z)

string

query

starttime
任意

最初にログを取得する時間 (%m/%d/%Y %Z)

string

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.5. listAllOrganizations

現在のシステムの組織をリスト表示します。

GET /api/v1/superuser/organizations

認可: oauth2_implicit(super:user)

クエリーパラメーター
Expand
タイプ名前説明スキーマ

path

name
必須

管理対象の組織名

string

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

コマンドの例
$ curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/organizations/"
Copy to Clipboard Toggle word wrap

2.21.6. createServiceKey

POST /api/v1/superuser/keys

認可: oauth2_implicit(super:user)

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

サービスキーの作成の説明

Expand
名前説明スキーマ

サービス
必須

このキーで認証されるサービス

string

name
任意

サービスキーの判別しやすい名前

string

metadata
任意

このキーのメタデータのキー/値のペア

object

notes
任意

指定すると、キーにメモを追加で指定できます。

string

有効期限
必須

unix タイムスタンプとしての有効期限

 
応答
Expand
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.7. listServiceKeys

GET /api/v1/superuser/keys

認可: oauth2_implicit(super:user)

応答
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.8. changeUserQuotaSuperUser

PUT /api/v1/superuser/organization/{namespace}/quota/{quota_id}

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

namespace
必須

 

string

path

quota_id
必須

 

string

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

新しい組織の割り当ての説明

Expand
名前説明スキーマ

limit_bytes
任意

組織で許可されているバイト数

integer

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.9. deleteUserQuotaSuperUser

DELETE /api/v1/superuser/organization/{namespace}/quota/{quota_id}

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

namespace
必須

 

string

path

quota_id
必須

 

string

レスポンス
Expand
HTTP コード説明スキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.10. createUserQuotaSuperUser

POST /api/v1/superuser/organization/{namespace}/quota

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

namespace
必須

 

string

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

新しい組織の割り当ての説明

Expand
名前説明スキーマ

limit_bytes
必須

組織で許可されているバイト数

integer

レスポンス
Expand
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.11. listUserQuotaSuperUser

GET /api/v1/superuser/organization/{namespace}/quota

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

namespace
必須

 

string

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.12. changeOrganizationQuotaSuperUser

PUT /api/v1/superuser/users/{namespace}/quota/{quota_id}

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

namespace
必須

 

string

path

quota_id
必須

 

string

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

新しい組織の割り当ての説明

Expand
名前説明スキーマ

limit_bytes
任意

組織で許可されているバイト数

integer

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.13. deleteOrganizationQuotaSuperUser

DELETE /api/v1/superuser/users/{namespace}/quota/{quota_id}

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

namespace
必須

 

string

path

quota_id
必須

 

string

レスポンス
Expand
HTTP コード説明スキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.14. createOrganizationQuotaSuperUser

POST /api/v1/superuser/users/{namespace}/quota

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

namespace
必須

 

string

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

新しい組織の割り当ての説明

Expand
名前説明スキーマ

limit_bytes
任意

組織で許可されているバイト数

integer

レスポンス
Expand
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.15. listOrganizationQuotaSuperUser

GET /api/v1/superuser/users/{namespace}/quota

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

namespace
必須

 

string

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.16. changeOrganization

指定したユーザーの情報を更新します。

PUT /api/v1/superuser/organizations/{name}

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

name
必須

管理する組織の名前

string

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

既存組織の更新の説明

Expand
名前説明スキーマ

email
任意

組織の連絡先メール

string

invoice_email
任意

組織が請求書のメールを受信する必要があるかどうか。

boolean

invoice_email_address
任意

請求書を受信するメールアドレス

 

tag_expiration_s
任意

タグの有効期限 (秒)

integer

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.17. deleteOrganization

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

DELETE /api/v1/superuser/organizations/{name}

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

name
必須

管理する組織の名前

string

レスポンス
Expand
HTTP コード説明スキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.18. approveServiceKey

POST /api/v1/superuser/approvedkeys/{kid}

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

kid
必須

サービスキーの一意識別子

string

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

サービスキーの承認に関する情報

Expand
名前説明スキーマ

notes
任意

オプションの承認に関する注意事項

string

レスポンス
Expand
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.19. deleteServiceKey

DELETE /api/v1/superuser/keys/{kid}

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

kid
必須

サービスキーの一意識別子

string

レスポンス
Expand
HTTP コード説明スキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.20. updateServiceKey

PUT /api/v1/superuser/keys/{kid}

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

kid
必須

サービスキーの一意識別子

string

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

サービスキーの更新の説明

Expand
名前説明スキーマ

name
任意

サービスキーの判別しやすい名前

string

metadata
任意

このキーのメタデータのキー/値のペア

object

expiration
任意

unix タイムスタンプとしての有効期限

 
応答
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.21. getServiceKey

GET /api/v1/superuser/keys/{kid}

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

kid
必須

サービスキーの一意識別子

string

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.22. getRepoBuildStatusSuperUser

ビルドの uuid で指定したビルドのステータスを返します。

GET /api/v1/superuser/{build_uuid}/status

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

build_uuid
必須

ビルドの UUID

string

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.23. getRepoBuildSuperUser

ビルドに関する情報を返します。

GET /api/v1/superuser/{build_uuid}/build

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

build_uuid
必須

ビルドの UUID

string

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.24. getRepoBuildLogsSuperUser

ビルド uuid で指定したビルドのビルドログを返します。

GET /api/v1/superuser/{build_uuid}/logs

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

build_uuid
必須

ビルドの UUID

string

レスポンス
Expand
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.25. getRegistrySize

GET /api/v1/superuser/registrysize/

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

namespace
必須

 

string

イメージレジストリーサイズの説明

Expand
Name説明スキーマ

size_bytes*
optional

組織で許可されているバイト数

integer

last_ran

 

integer

queued

 

boolean

running

 

boolean

応答
Expand
HTTP コード説明スキーマ

200

作成済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.21.26. postRegistrySize

POST /api/v1/superuser/registrysize/

認可: oauth2_implicit(super:user)

パスパラメーター
Expand
タイプ名前説明スキーマ

path

namespace
必須

 

string

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

イメージレジストリーサイズの説明

Expand
Name説明スキーマ

last_ran

 

integer

queued

 

boolean

running

 

boolean

応答
Expand
HTTP コード説明スキーマ

201

作成済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat