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