2.20. スーパーユーザー
スーパーユーザー API。
2.20.1. listAllUsers
システム内の全ユーザー一覧を返します。
GET /api/v1/superuser/users/
承認: oauth2_implicit(super:user)
クエリーパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
query |
disabled | false の場合には、有効なユーザーのみが返されます。 | ブール値 |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.2. createInstallUser
新しいユーザーを作成します。
POST /api/v1/superuser/users/
承認: oauth2_implicit(super:user)
要求のボディースキーマ (アプリケーション/json)
ユーザー作成のデータ
名前 | 説明 | スキーマ |
---|---|---|
username | 作成されるユーザーの名前 | string |
email | 作成中のユーザーのメールアドレス | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
201 | 作成成功 | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.3. listAllLogs
現在のシステムの使用状況ログを一覧表示します。
GET /api/v1/superuser/logs
承認: oauth2_implicit(super:user)
クエリーパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
query |
next_page | 次のページのページトークン | string |
query |
page | ログのページ番号 | 整数 |
query |
endtime | 最後にログを取得した時間 (%m/%d/%Y %Z) | string |
query |
starttime | 最初にログを取得する時間 (%m/%d/%Y %Z) | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.4. listServiceKeys
GET /api/v1/superuser/keys
承認: oauth2_implicit(super:user)
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.5. createServiceKey
POST /api/v1/superuser/keys
承認: oauth2_implicit(super:user)
要求のボディースキーマ (アプリケーション/json)
サービスキーの作成の説明
名前 | 説明 | スキーマ |
---|---|---|
service | このキーで認証されるサービス | string |
name | サービスキーの判別しやすい名前 | string |
metadata | このキーのメタデータのキー/値のペア | object |
notes | 指定すると、キーにメモを追加で指定できます。 | string |
expiration | unix タイムスタンプとしての有効期限 |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
201 | 作成成功 | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.6. deleteUserQuotaSuperUser
DELETE /api/v1/superuser/organization/{namespace}/quota/{quota_id}
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
quota_id | string | |
path |
namespace | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
204 | 削除済み | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.7. changeUserQuotaSuperUser
PUT /api/v1/superuser/organization/{namespace}/quota/{quota_id}
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
quota_id | string | |
path |
namespace | string |
要求のボディースキーマ (アプリケーション/json)
新しい組織の割り当ての説明
名前 | 説明 | スキーマ |
---|---|---|
limit_bytes | 組織で許可されているバイト数 | 整数 |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.8. createUserQuotaSuperUser
POST /api/v1/superuser/organization/{namespace}/quota
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
namespace | string |
要求のボディースキーマ (アプリケーション/json)
新しい組織の割り当ての説明
名前 | 説明 | スキーマ |
---|---|---|
limit_bytes | 組織で許可されているバイト数 | 整数 |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
201 | 作成成功 | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.9. deleteOrganizationQuotaSuperUser
DELETE /api/v1/superuser/users/{namespace}/quota/{quota_id}
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
quota_id | string | |
path |
namespace | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
204 | 削除済み | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.10. changeOrganizationQuotaSuperUser
PUT /api/v1/superuser/users/{namespace}/quota/{quota_id}
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
quota_id | string | |
path |
namespace | string |
要求のボディースキーマ (アプリケーション/json)
新しい組織の割り当ての説明
名前 | 説明 | スキーマ |
---|---|---|
limit_bytes | 組織で許可されているバイト数 | 整数 |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.11. createOrganizationQuotaSuperUser
POST /api/v1/superuser/users/{namespace}/quota
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
namespace | string |
要求のボディースキーマ (アプリケーション/json)
新しい組織の割り当ての説明
名前 | 説明 | スキーマ |
---|---|---|
limit_bytes | 組織で許可されているバイト数 | 整数 |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
201 | 作成成功 | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.12. deleteOrganization
指定した組織を削除します。
DELETE /api/v1/superuser/organizations/{name}
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
name | 管理する組織の名前 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
204 | 削除済み | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.13. changeOrganization
指定したユーザーの情報を更新します。
PUT /api/v1/superuser/organizations/{name}
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
name | 管理する組織の名前 | string |
要求のボディースキーマ (アプリケーション/json)
既存組織の更新の説明
名前 | 説明 | スキーマ |
---|---|---|
email | 組織の連絡先メール | string |
invoice_email | 組織が請求書のメールを受信する必要があるかどうか | boolean |
invoice_email_address | 請求書を受信するメールアドレス | |
tag_expiration_s | タグの有効期限 (秒) | 整数 |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.14. approveServiceKey
POST /api/v1/superuser/approvedkeys/{kid}
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
kid | サービスキーの一意識別子 | string |
要求のボディースキーマ (アプリケーション/json)
サービスキーの承認に関する情報
名前 | 説明 | スキーマ |
---|---|---|
notes | オプションの承認に関する注意事項 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
201 | 作成成功 | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.15. getServiceKey
GET /api/v1/superuser/keys/{kid}
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
kid | サービスキーの一意識別子 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.16. deleteServiceKey
DELETE /api/v1/superuser/keys/{kid}
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
kid | サービスキーの一意識別子 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
204 | 削除済み | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.17. updateServiceKey
PUT /api/v1/superuser/keys/{kid}
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
kid | サービスキーの一意識別子 | string |
要求のボディースキーマ (アプリケーション/json)
サービスキーの更新の説明
名前 | 説明 | スキーマ |
---|---|---|
name | サービスキーの判別しやすい名前 | string |
metadata | このキーのメタデータのキー/値のペア | object |
expiration | unix タイムスタンプとしての有効期限 |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.18. getRepoBuildStatusSuperUser
ビルドの uuid で指定したビルドのステータスを返します。
GET /api/v1/superuser/{build_uuid}/status
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
build_uuid | ビルドの UUID | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.19. getRepoBuildSuperUser
ビルドに関する情報を返します。
GET /api/v1/superuser/{build_uuid}/build
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
build_uuid | ビルドの UUID | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.20.20. getRepoBuildLogsSuperUser
ビルド uuid で指定したビルドのビルドログを返します。
GET /api/v1/superuser/{build_uuid}/logs
承認: oauth2_implicit(super:user)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
build_uuid | ビルドの UUID | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |