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
リンクのコピー

Expand

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

HTTP メソッド: POST
説明: UserIdentityMapping を作成します。

Expand

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

Expand

表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}
リンクのコピー

Expand

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

Expand

表4.5 グローバルクエリーパラメーター
パラメーター	型	説明
`pretty`	`string`	'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド: DELETE
説明: UserIdentityMapping を削除します。

Expand

表4.6 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。
`gracePeriodSeconds`	`integer`	オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。
`orphanDependents`	`boolean`	非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。
`propagationPolicy`	`string`	ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。

Expand

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

Expand

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

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

Expand

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

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

Expand

表4.10 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。
`fieldManager`	`string`	fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。
`force`	`boolean`	"force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。

Expand

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

Expand

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

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

Expand

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

Expand

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

Expand

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

トップに戻る

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat