Role APIs
ロール API のリファレンスガイド
概要
第1章 Role APIs リンクのコピーリンクがクリップボードにコピーされました!
1.1. ClusterRoleBinding [authorization.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
ClusterRoleBinding は ClusterRole を参照しますが、それを含みません。同じ namespace またはグローバル namespace 内の任意の ClusterRole を参照できます。(ユーザーとグループ) またはサブジェクトを介して who 情報を追加し、どの namespace に存在するかに応じて namespace 情報を追加します。特定の namespace の ClusterRoleBindings は、その namespace でのみ有効です (すべての namespace で権限を持つマスター namespace を除く)。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
1.2. ClusterRole [authorization.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
ClusterRole は、ClusterRoleBindings が 1 つの単位として参照できる PolicyRules の論理グループです。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
1.3. RoleBindingRestriction [authorization.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
RoleBindingRestriction は、サブジェクト (ユーザー、グループ、またはサービスアカウント) と照合して、そのサブジェクトのロールバインディングが RoleBindingRestriction が属する namespace で許可されているかどうかを判断できるオブジェクトです。これらの RoleBindingRestriction オブジェクトのいずれかがサブジェクトと一致する場合は、namespace 内のそのサブジェクトに対するロールバインディングが許可されます。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
1.4. RoleBinding [authorization.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
RoleBinding は Role を参照しますが、Role を含みません。同じ namespace またはグローバル namespace 内の任意の Role を参照できます。(ユーザーとグループ) またはサブジェクトを介して who 情報を追加し、どの namespace に存在するかに応じて namespace 情報を追加します。特定の namespace の RoleBindings は、その namespace でのみ有効です (すべての namespace で権限を持つマスター namespace を除く)。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
1.5. Role [authorization.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
Role は、RoleBindings が 1 つの単位として参照できる PolicyRules の論理グループです。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
第2章 ClusterRoleBinding [authorization.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
ClusterRoleBinding は ClusterRole を参照しますが、それを含みません。同じ namespace またはグローバル namespace 内の任意の ClusterRole を参照できます。(ユーザーとグループ) またはサブジェクトを介して who 情報を追加し、どの namespace に存在するかに応じて namespace 情報を追加します。特定の namespace の ClusterRoleBindings は、その namespace でのみ有効です (すべての namespace で権限を持つマスター namespace を除く)。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object - 必須
-
subjects -
roleRef
-
2.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| groupNames は、ロールに直接バインドされているすべてのグループを保持します。このフィールドは、レガシークライアントおよびサーバーをサポートする場合にのみ指定する必要があります。詳細は、主題を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| roleRef は、現在の namespace とグローバル namespace のみを参照できます。ClusterRoleRef を解決できない場合は、Authorizer がエラーを返す必要があります。ポリシーはシングルトンであるため、これはロールを見つけるのに十分な知識です。 | |
|
| subjects は、このルールで承認するためのオブジェクト参照を保持します。UserNames または GroupNames がレガシークライアントおよびサーバーをサポートするように指定されていると、このフィールドは無視されます。したがって、下位互換性をサポートする必要のない新しいクライアントは、完全に修飾されたサブジェクトのみを送信し、UserNames フィールドと GroupNames フィールドを省略する必要があります。下位互換性をサポートする必要があるクライアントは、このフィールドを使用して UserNames と GroupNames を作成できます。 | |
|
|
| userNames は、ロールに直接バインドされているすべてのユーザー名を保持します。このフィールドは、レガシークライアントおよびサーバーをサポートする場合にのみ指定する必要があります。詳細は、主題を参照してください。 |
2.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/authorization.openshift.io/v1/clusterrolebindings-
GET: 種類 ClusterRoleBinding のオブジェクトをリスト表示する -
POST:ClusterRoleBinding を作成します。
-
/apis/authorization.openshift.io/v1/clusterrolebindings/{name}-
DELETE: ClusterRoleBinding を削除します。 -
GET: 指定された ClusterRoleBinding を読み取ります。 -
PATCH: 指定された ClusterRoleBinding を部分的に更新します。 -
PUT: 指定された ClusterRoleBinding を置き換えます。
-
2.2.1. /apis/authorization.openshift.io/v1/clusterrolebindings リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
GET - 説明
- 種類 ClusterRoleBinding のオブジェクトをリスト表示する
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ClusterRoleBinding を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
2.2.2. /apis/authorization.openshift.io/v1/clusterrolebindings/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ClusterRoleBinding の名前 |
- HTTP メソッド
-
DELETE - 説明
- ClusterRoleBinding を削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された ClusterRoleBinding を読み取る
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ClusterRoleBinding を部分的に更新する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ClusterRoleBinding を置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第3章 ClusterRole [authorization.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
ClusterRole は、ClusterRoleBindings が 1 つの単位として参照できる PolicyRules の論理グループです。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object - 必須
-
rules
-
3.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
| aggregationRule は、この ClusterRole のルールを作成する方法を説明するオプションのフィールドです。aggregationRule が設定されていると、ルールはコントローラーにより管理され、ルールへの直接の変更はコントローラーにより拒否されます。 | |
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| ルールは、この ClusterRole のすべての PolicyRules を保持する |
|
|
| PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。 |
3.1.1. .rules リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ルールは、この ClusterRole のすべての PolicyRules を保持する
- 型
-
array
3.1.2. .rules[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。
- 型
-
object - 必須
-
verbs -
resources
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiGroups は、リソースを含む APIGroup の名前です。このフィールドが空の場合は、kubernetes と origin API グループの両方が想定されます。つまり、kubernetes またはオリジン API グループのいずれかで列挙されたリソースのいずれかに対してアクションがリクエストされると、そのリクエストは許可されます。 |
|
| attributeRestrictions は、Authorizer/AuthorizationAttributeBuilder ペアがサポートするものに応じて異なります。authorizer が AttributeRestrictions の処理方法を認識しないと、authorizer がエラーを報告します。 | |
|
|
| nonResourceURLsSlice は、ユーザーがアクセスできる必要のある部分的な URL のセットです。* は許可されますが、パスの完全な最終ステップとしてのみこの名前は内部タイプとは意図的に異なります。これにより、DefaultConvert が適切に機能し、順序が異なる場合があります。 |
|
|
| resourceNames は、ルールが適用される名前のオプションのホワイトリストです。空のセットは、すべてが許可されていることを意味します。 |
|
|
| resources は、このルールが適用されるリソースのリストです。resourceAll は、すべてのリソースを表します。 |
|
|
| verbs は、このルールに含まれるすべての ResourceKinds と AttributeRestrictions に適用される動詞のリストです。verbAll はすべての種類を表します。 |
3.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/authorization.openshift.io/v1/clusterroles-
GET: 種類 ClusterRole のオブジェクトをリスト表示する -
POST:ClusterRole を作成します。
-
/apis/authorization.openshift.io/v1/clusterroles/{name}-
削除:ClusterRole を削除します。 -
GET: 指定された ClusterRole を読み取る -
PATCH: 指定された ClusterRole を部分的に更新する -
PUT: 指定された ClusterRole を置き換えます。
-
3.2.1. /apis/authorization.openshift.io/v1/clusterroles リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
GET - 説明
- 種類が ClusterRole のオブジェクトをリスト表示します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ClusterRole の作成
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
3.2.2. /apis/authorization.openshift.io/v1/clusterroles/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ClusterRole の名前 |
- HTTP メソッド
-
DELETE - 説明
- ClusterRole を削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された ClusterRole を読み取る
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ClusterRole を部分的に更新する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ClusterRole を置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第4章 RoleBindingRestriction [authorization.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
RoleBindingRestriction は、サブジェクト (ユーザー、グループ、またはサービスアカウント) と照合して、そのサブジェクトのロールバインディングが RoleBindingRestriction が属する namespace で許可されているかどうかを判断できるオブジェクトです。これらの RoleBindingRestriction オブジェクトのいずれかがサブジェクトと一致する場合は、namespace 内のそのサブジェクトに対するロールバインディングが許可されます。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
4.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| spec はマッチャーを定義します。 |
4.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec はマッチャーを定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
| `` | grouprestriction はグループサブジェクトと一致します。 |
|
| `` | serviceaccountrestriction は、サービスアカウントのサブジェクトと一致します。 |
|
| `` | userrestriction はユーザーサブジェクトと一致します。 |
4.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/authorization.openshift.io/v1/rolebindingrestrictions-
GET: 種類 RoleBindingRestriction のオブジェクトをリスト表示する
-
/apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindingrestrictions-
DELETE: RoleBindingRestriction のコレクションを削除する -
GET: 種類 RoleBindingRestriction のオブジェクトをリスト表示する -
POST: RoleBindingRestriction を作成します。
-
/apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindingrestrictions/{name}-
DELETE: RoleBindingRestriction を削除します。 -
GET: 指定された RoleBindingRestriction を読み取る -
PATCH: 指定された RoleBindingRestriction を部分的に更新する -
PUT: 指定された RoleBindingRestriction を置き換えます。
-
4.2.1. /apis/authorization.openshift.io/v1/rolebindingrestrictions リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
GET - 説明
- 種類 RoleBindingRestriction のオブジェクトをリスト表示する
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
4.2.2. /apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindingrestrictions リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- RoleBindingRestriction のコレクションを削除する
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類 RoleBindingRestriction のオブジェクトをリスト表示する
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- RoleBindingRestriction を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空白 |
4.2.3. /apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindingrestrictions/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| RoleBindingRestriction の名前 |
- HTTP メソッド
-
DELETE - 説明
- RoleBindingRestriction を削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された RoleBindingRestriction を読み取る
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された RoleBindingRestriction を部分的に更新する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された RoleBindingRestriction を置き換える
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空白 |
第5章 RoleBinding [authorization.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
RoleBinding は Role を参照しますが、Role を含みません。同じ namespace またはグローバル namespace 内の任意の Role を参照できます。(ユーザーとグループ) またはサブジェクトを介して who 情報を追加し、どの namespace に存在するかに応じて namespace 情報を追加します。特定の namespace の RoleBindings は、その namespace でのみ有効です (すべての namespace で権限を持つマスター namespace を除く)。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object - 必須
-
subjects -
roleRef
-
5.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| groupNames は、ロールに直接バインドされているすべてのグループを保持します。このフィールドは、レガシークライアントおよびサーバーをサポートする場合にのみ指定する必要があります。詳細は、主題を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| roleRef は、現在の namespace とグローバル namespace のみを参照できます。roleRef を解決できない場合は、Authorizer がエラーを返す必要があります。ポリシーはシングルトンであるため、これはロールを見つけるのに十分な知識です。 | |
|
| subjects は、このルールで承認するためのオブジェクト参照を保持します。UserNames または GroupNames がレガシークライアントおよびサーバーをサポートするように指定されていると、このフィールドは無視されます。したがって、下位互換性をサポートする必要のない新しいクライアントは、完全に修飾されたサブジェクトのみを送信し、UserNames フィールドと GroupNames フィールドを省略する必要があります。下位互換性をサポートする必要があるクライアントは、このフィールドを使用して UserNames と GroupNames を作成できます。 | |
|
|
| userNames は、ロールに直接バインドされているすべてのユーザー名を保持します。このフィールドは、レガシークライアントおよびサーバーをサポートする場合にのみ指定する必要があります。詳細は、主題を参照してください。 |
5.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/authorization.openshift.io/v1/rolebindings-
GET: 種類 RoleBinding のオブジェクトをリスト表示する
-
/apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindings-
GET: 種類 RoleBinding のオブジェクトをリスト表示する -
POST:RoleBinding を作成します。
-
/apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindings/{name}-
削除:RoleBinding を削除します。 -
GET: 指定された RoleBinding を読み取る -
PATCH: 指定された RoleBinding を部分的に更新する -
PUT: 指定された RoleBinding を置き換えます。
-
5.2.1. /apis/authorization.openshift.io/v1/rolebindings リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
GET - 説明
- 種類が RoleBinding のオブジェクトをリスト表示します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
5.2.2. /apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindings リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
GET - 説明
- 種類が RoleBinding のオブジェクトをリスト表示します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- RoleBinding を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
5.2.3. /apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindings/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| RoleBinding の名前 |
- HTTP メソッド
-
DELETE - 説明
- RoleBinding を削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された RoleBinding を読み取る
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された RoleBinding を部分的に更新する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された RoleBinding を置き換える
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第6章 Role [authorization.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
Role は、RoleBindings が 1 つの単位として参照できる PolicyRules の論理グループです。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object - 必須
-
rules
-
6.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| rules は、この Role のすべての PolicyRules を保持します。 |
|
|
| PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。 |
6.1.1. .rules リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- rules は、この Role のすべての PolicyRules を保持します。
- 型
-
array
6.1.2. .rules[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。
- 型
-
object - 必須
-
verbs -
resources
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiGroups は、リソースを含む APIGroup の名前です。このフィールドが空の場合は、kubernetes と origin API グループの両方が想定されます。つまり、kubernetes またはオリジン API グループのいずれかで列挙されたリソースのいずれかに対してアクションがリクエストされると、そのリクエストは許可されます。 |
|
| attributeRestrictions は、Authorizer/AuthorizationAttributeBuilder ペアがサポートするものに応じて異なります。authorizer が AttributeRestrictions の処理方法を認識しないと、authorizer がエラーを報告します。 | |
|
|
| nonResourceURLsSlice は、ユーザーがアクセスできる必要のある部分的な URL のセットです。* は許可されますが、パスの完全な最終ステップとしてのみこの名前は内部タイプとは意図的に異なります。これにより、DefaultConvert が適切に機能し、順序が異なる場合があります。 |
|
|
| resourceNames は、ルールが適用される名前のオプションのホワイトリストです。空のセットは、すべてが許可されていることを意味します。 |
|
|
| resources は、このルールが適用されるリソースのリストです。resourceAll は、すべてのリソースを表します。 |
|
|
| verbs は、このルールに含まれるすべての ResourceKinds と AttributeRestrictions に適用される動詞のリストです。verbAll はすべての種類を表します。 |
6.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/authorization.openshift.io/v1/roles-
GET: 種類 Role のオブジェクトをリスト表示する
-
/apis/authorization.openshift.io/v1/namespaces/{namespace}/roles-
GET: 種類 Role のオブジェクトをリスト表示する -
POST: Role を作成します。
-
/apis/authorization.openshift.io/v1/namespaces/{namespace}/roles/{name}-
削除: Role を削除します。 -
GET: 指定された Role を読み取ります。 -
PATCH: 指定された Role を部分的に更新します。 -
PUT: 指定された Role を置き換えます。
-
6.2.1. /apis/authorization.openshift.io/v1/roles リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
GET - 説明
- 種類 Role のオブジェクトをリスト表示する
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
6.2.2. /apis/authorization.openshift.io/v1/namespaces/{namespace}/roles リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
GET - 説明
- 種類 Role のオブジェクトをリスト表示する
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- Role を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
6.2.3. /apis/authorization.openshift.io/v1/namespaces/{namespace}/roles/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| Role の名前です。 |
- HTTP メソッド
-
DELETE - 説明
- Role を削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された Role を読み取る
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された Role を部分的に更新する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された Role を置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|