ユーザーおよびグループ API

第1章ユーザーおよびグループ API

1.1. Group [user.openshift.io/v1]

説明

Group は、参照可能な Users のセットを表します

互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

型

object

1.2. Identity [user.openshift.io/v1]

説明

Identity は、ID プロバイダーによるユーザーの認証の成功を記録します。認証のソースに関する情報は ID に保存され、ID は単一のユーザーオブジェクトに関連付けられます。複数の ID が 1 人のユーザーを参照できます。認証プロバイダーから取得した情報は、プロバイダーによって決定されたスキーマを使用して追加フィールドに格納されます。

互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

型

object

1.3. UserIdentityMapping [user.openshift.io/v1]

説明

UserIdentityMapping は、ユーザーを ID にマップします

互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

型

object

1.4. User [user.openshift.io/v1]

説明

ログインすると、システムのすべてのユーザーが User および ID リソースを受け取ります。管理者は、ユーザーの属性を直接操作して独自の追跡を行ったり、API を介してグループを設定したりできます。ユーザー名は一意であり、ID プロバイダーから提供された値に基づいて選択されます。ユーザーが着信名ですでに存在する場合、システムの設定によっては、ユーザー名に番号が追加される場合があります。

互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

型

object

第2章 Group [user.openshift.io/v1]

説明

Group は、参照可能な Users のセットを表します

互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

型

object

必須

users

2.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta_v2`	metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`users`	`array (string)`	ユーザーは、このグループのユーザーのリストです。

2.2. API エンドポイント

以下の API エンドポイントを利用できます。

/apis/user.openshift.io/v1/groups
- DELETE: Group のコレクションを削除する
- GET: Group 種類のオブジェクトをリスト表示または監視するロール
- POST: グループを作成する
/apis/user.openshift.io/v1/watch/groups
- GET: Group のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/apis/user.openshift.io/v1/groups/{name}
- DELETE: Group を削除する
- GET: 指定された Group を読み取る
- PATCH: 指定された Group を部分的に更新します。
- PUT: 指定された Group を置き換える
/apis/user.openshift.io/v1/watch/groups/{name}
- GET: Group 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

2.2.1. /apis/user.openshift.io/v1/groups

HTTP メソッド: DELETE
説明: グループのコレクションを削除する

表2.1 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表2.2 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status_v11` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: Group 種類のオブジェクトをリスト表示または監視するロール

表2.3 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`GroupList` スキーマ
401 - Unauthorized	空白

HTTP メソッド: POST
説明: グループを作成する

表2.4 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表2.5 ボディのパラメーター
パラメーター	型	説明
`body`	`Group` スキーマ

表2.6 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Group` スキーマ
201 - Created	`Group` スキーマ
202 - Accepted	`Group` スキーマ
401 - Unauthorized	空白

2.2.2. /apis/user.openshift.io/v1/watch/groups

HTTP メソッド: GET
説明: Group のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表2.7 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

2.2.3. /apis/user.openshift.io/v1/groups/{name}

表2.8 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	Group の名前

HTTP メソッド: DELETE
説明: Group を削除する

表2.9 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表2.10 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status_v11` スキーマ
202 - Accepted	`Status_v11` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定された Group を読み取る

表2.11 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Group` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定された Group を部分的に更新する

表2.12 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表2.13 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Group` スキーマ
201 - Created	`Group` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定されたグループを置き換える

表2.14 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表2.15 ボディのパラメーター
パラメーター	型	説明
`body`	`Group` スキーマ

表2.16 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Group` スキーマ
201 - Created	`Group` スキーマ
401 - Unauthorized	空白

2.2.4. /apis/user.openshift.io/v1/watch/groups/{name}

表2.17 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	Group の名前

HTTP メソッド: GET
説明: Group 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

表2.18 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

第3章 Identity [user.openshift.io/v1]

説明

Identity は、ID プロバイダーによるユーザーの認証の成功を記録します。認証のソースに関する情報は ID に保存され、ID は単一のユーザーオブジェクトに関連付けられます。複数の ID が 1 人のユーザーを参照できます。認証プロバイダーから取得した情報は、プロバイダーによって決定されたスキーマを使用して追加フィールドに格納されます。

互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

型

object

必須

providerName
providerUserName
user

3.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`extra`	`object (string)`	Extra は、この ID に関する追加情報を保持します
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta_v2`	metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`providerName`	`string`	ProviderName は ID 情報のソースです
`providerUserName`	`string`	ProviderUserName は、プロバイダーのスコープ内でこの ID を一意に表します
`user`	`ObjectReference`	ユーザーは、この ID が関連付けられているユーザーへの参照です。Name と UID の両方を設定する必要があります

3.2. API エンドポイント

以下の API エンドポイントを利用できます。

/apis/user.openshift.io/v1/identities
- DELETE: ID のコレクションを削除する
- GET: ID 種類のオブジェクトをリスト表示または監視する
- POST: ID を作成する
/apis/user.openshift.io/v1/watch/identities
- GET: Identity のリストへの個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/apis/user.openshift.io/v1/identities/{name}
- DELETE: ID を削除する
- GET: 指定された ID を読み取る
- PATCH: 指定された ID を部分的に更新する
- PUT: 指定された ID を置き換える
/apis/user.openshift.io/v1/watch/identities/{name}
- GET: Identity 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

3.2.1. /apis/user.openshift.io/v1/identities

HTTP メソッド: DELETE
説明: ID のコレクションを削除する

表3.1 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表3.2 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status_v11` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: ID 種類のオブジェクトをリスト表示または監視する

表3.3 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`IdentityList` スキーマ
401 - Unauthorized	空白

HTTP メソッド: POST
説明: ID を作成する

表3.4 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表3.5 ボディのパラメーター
パラメーター	型	説明
`body`	`Identity` スキーマ

表3.6 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Identity` スキーマ
201 - Created	`Identity` スキーマ
202 - Accepted	`Identity` スキーマ
401 - Unauthorized	空白

3.2.2. /apis/user.openshift.io/v1/watch/identities

HTTP メソッド: GET
説明: Identity のリストへの個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表3.7 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

3.2.3. /apis/user.openshift.io/v1/identities/{name}

表3.8 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	Identity の名前

HTTP メソッド: DELETE
説明: ID を削除する

表3.9 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表3.10 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status_v11` スキーマ
202 - Accepted	`Status_v11` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定された ID を読み取る

表3.11 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Identity` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定された ID を部分的に更新する

表3.12 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表3.13 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Identity` スキーマ
201 - Created	`Identity` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定された ID を置き換える

表3.14 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表3.15 ボディのパラメーター
パラメーター	型	説明
`body`	`Identity` スキーマ

表3.16 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Identity` スキーマ
201 - Created	`Identity` スキーマ
401 - Unauthorized	空白

3.2.4. /apis/user.openshift.io/v1/watch/identities/{name}

表3.17 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	Identity の名前

HTTP メソッド: GET
説明: Identity 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

表3.18 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

第4章 UserIdentityMapping [user.openshift.io/v1]

説明

UserIdentityMapping は、ユーザーを ID にマップします

互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

型

object

4.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`identity`	`ObjectReference`	Identity は ID への参照です
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta_v2`	metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`user`	`ObjectReference`	ユーザーはユーザーへの参照である

4.2. API エンドポイント

以下の API エンドポイントを利用できます。

/apis/user.openshift.io/v1/useridentitymappings
- POST: UserIdentityMapping を作成する
/apis/user.openshift.io/v1/useridentitymappings/{name}
- DELETE: UserIdentityMapping を削除する
- GET: 指定された UserIdentityMapping を読み取る
- PATCH: 指定された UserIdentityMapping を部分的に更新する
- PUT: 指定された UserIdentityMapping を置き換える

4.2.1. /apis/user.openshift.io/v1/useridentitymappings

表4.1 グローバルクエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

HTTP メソッド: POST
説明: UserIdentityMapping を作成する

表4.2 本文パラメーター
パラメーター	型	説明
`body`	`UserIdentityMapping` スキーマ

表4.3 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`UserIdentityMapping` スキーマ
201 - Created	`UserIdentityMapping` スキーマ
202 - Accepted	`UserIdentityMapping` スキーマ
401 - Unauthorized	空白

4.2.2. /apis/user.openshift.io/v1/useridentitymappings/{name}

表4.4 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	UserIdentityMapping の名前

HTTP メソッド: DELETE
説明: UserIdentityMapping を削除する

表4.5 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表4.6 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status_v11` スキーマ
202 - Accepted	`Status_v11` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定された UserIdentityMapping を読み取る

表4.7 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`UserIdentityMapping` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定された UserIdentityMapping を部分的に更新する

表4.8 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表4.9 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`UserIdentityMapping` スキーマ
201 - Created	`UserIdentityMapping` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定された UserIdentityMapping を置き換える

表4.10 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表4.11 ボディのパラメーター
パラメーター	型	説明
`body`	`UserIdentityMapping` スキーマ

表4.12 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`UserIdentityMapping` スキーマ
201 - Created	`UserIdentityMapping` スキーマ
401 - Unauthorized	空白

第5章 User [user.openshift.io/v1]

説明

ログインすると、システムのすべてのユーザーが User および ID リソースを受け取ります。管理者は、ユーザーの属性を直接操作して独自の追跡を行ったり、API を介してグループを設定したりできます。ユーザー名は一意であり、ID プロバイダーから提供された値に基づいて選択されます。ユーザーが着信名ですでに存在する場合、システムの設定によっては、ユーザー名に番号が追加される場合があります。

互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

型

object

必須

groups

5.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`fullName`	`string`	FullName はユーザーのフルネームです。
`groups`	`array (string)`	Groups は、このユーザーがメンバーになっているグループ名を指定します。このフィールドは非推奨であり、将来のリリースで削除される予定です。代わりに、この User の名前を含む Group オブジェクトを作成します。
`identities`	`array (string)`	ID は、このユーザーに関連付けられている ID です。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta_v2`	metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

5.2. API エンドポイント

以下の API エンドポイントを利用できます。

/apis/user.openshift.io/v1/users
- DELETE: User のコレクションを削除します。
- GET: User 種類のオブジェクトをリスト表示または監視します。
- POST: ユーザーを作成する
/apis/user.openshift.io/v1/watch/users
- GET: User のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/apis/user.openshift.io/v1/users/{name}
- DELETE: User を削除する
- GET: 指定された User を読み取る
- PATCH: 指定された User を部分的に更新します
- PUT: 指定された User を置き換えます
/apis/user.openshift.io/v1/watch/users/{name}
- GET: User 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

5.2.1. /apis/user.openshift.io/v1/users

HTTP メソッド: DELETE
説明: User のコレクションを削除する

表5.1 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表5.2 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status_v11` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: User 種類のオブジェクトをリスト表示または監視します。

表5.3 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`UserList` スキーマ
401 - Unauthorized	空白

HTTP メソッド: POST
説明: User を作成する

表5.4 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表5.5 ボディのパラメーター
パラメーター	型	説明
`body`	`User` スキーマ

表5.6 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`User` スキーマ
201 - Created	`User` スキーマ
202 - Accepted	`User` スキーマ
401 - Unauthorized	空白

5.2.2. /apis/user.openshift.io/v1/watch/users

HTTP メソッド: GET
説明: User のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表5.7 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

5.2.3. /apis/user.openshift.io/v1/users/{name}

表5.8 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	User の名前

HTTP メソッド: DELETE
説明: User を削除する

表5.9 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表5.10 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status_v11` スキーマ
202 - Accepted	`Status_v11` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定された User を読み取る

表5.11 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`User` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定された User を部分的に更新します。

表5.12 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表5.13 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`User` スキーマ
201 - Created	`User` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定された User を置き換える

表5.14 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表5.15 ボディのパラメーター
パラメーター	型	説明
`body`	`User` スキーマ

表5.16 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`User` スキーマ
201 - Created	`User` スキーマ
401 - Unauthorized	空白

5.2.4. /apis/user.openshift.io/v1/watch/users/{name}

表5.17 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	User の名前

HTTP メソッド: GET
説明: User 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

表5.18 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白