Role APIs


OpenShift Container Platform 4.20

ロール API のリファレンスガイド

概要

このドキュメントでは、OpenShift Container Platform ロール 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. 仕様

Expand
プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

groupNames

array (string)

groupNames は、ロールに直接バインドされているすべてのグループを保持します。このフィールドは、レガシークライアントおよびサーバーをサポートする場合にのみ指定する必要があります。詳細は、主題を参照してください。

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 を参照してください。

roleRef

ObjectReference

roleRef は、現在の namespace とグローバル namespace のみを参照できます。ClusterRoleRef を解決できない場合は、Authorizer がエラーを返す必要があります。ポリシーはシングルトンであるため、これはロールを見つけるのに十分な知識です。

subjects

array (ObjectReference)

subjects は、このルールで承認するためのオブジェクト参照を保持します。UserNames または GroupNames がレガシークライアントおよびサーバーをサポートするように指定されていると、このフィールドは無視されます。したがって、下位互換性をサポートする必要のない新しいクライアントは、完全に修飾されたサブジェクトのみを送信し、UserNames フィールドと GroupNames フィールドを省略する必要があります。下位互換性をサポートする必要があるクライアントは、このフィールドを使用して UserNames と GroupNames を作成できます。

userNames

array (string)

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 のオブジェクトをリスト表示する
Expand
表2.1 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterRoleBindingList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
ClusterRoleBinding を作成する
Expand
表2.2 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表2.3 本文パラメーター
パラメーター説明

body

ClusterRoleBinding スキーマ

 
Expand
表2.4 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterRoleBinding スキーマ

201 - Created

ClusterRoleBinding スキーマ

202 - Accepted

ClusterRoleBinding スキーマ

401 - Unauthorized

空白

2.2.2. /apis/authorization.openshift.io/v1/clusterrolebindings/{name}

Expand
表2.5 グローバルパスパラメーター
パラメーター説明

name

string

ClusterRoleBinding の名前

HTTP メソッド
DELETE
説明
ClusterRoleBinding を削除します。
Expand
表2.6 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表2.7 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status_v3 スキーマ

202 - Accepted

Status_v3 スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された ClusterRoleBinding を読み取る
Expand
表2.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterRoleBinding スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された ClusterRoleBinding を部分的に更新する
Expand
表2.9 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表2.10 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterRoleBinding スキーマ

201 - Created

ClusterRoleBinding スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された ClusterRoleBinding を置き換えます。
Expand
表2.11 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表2.12 本文パラメーター
パラメーター説明

body

ClusterRoleBinding スキーマ

 
Expand
表2.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterRoleBinding スキーマ

201 - Created

ClusterRoleBinding スキーマ

401 - Unauthorized

空白

第3章 ClusterRole [authorization.openshift.io/v1]

説明

ClusterRole は、ClusterRoleBindings が 1 つの単位として参照できる PolicyRules の論理グループです。

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

object
必須
  • rules

3.1. 仕様

Expand
プロパティー説明

aggregationRule

AggregationRule_v2

aggregationRule は、この ClusterRole のルールを作成する方法を説明するオプションのフィールドです。aggregationRule が設定されていると、ルールはコントローラーにより管理され、ルールへの直接の変更はコントローラーにより拒否されます。

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 を参照してください。

rules

array

ルールは、この ClusterRole のすべての PolicyRules を保持する

rules[]

object

PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。

3.1.1. .rules

説明
ルールは、この ClusterRole のすべての PolicyRules を保持する
array

3.1.2. .rules[]

説明
PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。
object
必須
  • verbs
  • resources
Expand
プロパティー説明

apiGroups

array (string)

apiGroups は、リソースを含む APIGroup の名前です。このフィールドが空の場合は、kubernetes と origin API グループの両方が想定されます。つまり、kubernetes またはオリジン API グループのいずれかで列挙されたリソースのいずれかに対してアクションがリクエストされると、そのリクエストは許可されます。

attributeRestrictions

RawExtension

attributeRestrictions は、Authorizer/AuthorizationAttributeBuilder ペアがサポートするものに応じて異なります。authorizer が AttributeRestrictions の処理方法を認識しないと、authorizer がエラーを報告します。

nonResourceURLs

array (string)

nonResourceURLsSlice は、ユーザーがアクセスできる必要のある部分的な URL のセットです。* は許可されますが、パスの完全な最終ステップとしてのみこの名前は内部タイプとは意図的に異なります。これにより、DefaultConvert が適切に機能し、順序が異なる場合があります。

resourceNames

array (string)

resourceNames は、ルールが適用される名前のオプションのホワイトリストです。空のセットは、すべてが許可されていることを意味します。

resources

array (string)

resources は、このルールが適用されるリソースのリストです。resourceAll は、すべてのリソースを表します。

verbs

array (string)

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 のオブジェクトをリスト表示します。
Expand
表3.1 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterRoleList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
ClusterRole の作成
Expand
表3.2 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表3.3 本文パラメーター
パラメーター説明

body

ClusterRole スキーマ

 
Expand
表3.4 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterRole スキーマ

201 - Created

ClusterRole スキーマ

202 - Accepted

ClusterRole スキーマ

401 - Unauthorized

空白

3.2.2. /apis/authorization.openshift.io/v1/clusterroles/{name}

Expand
表3.5 グローバルパスパラメーター
パラメーター説明

name

string

ClusterRole の名前

HTTP メソッド
DELETE
説明
ClusterRole を削除します。
Expand
表3.6 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表3.7 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status_v3 スキーマ

202 - Accepted

Status_v3 スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された ClusterRole を読み取る
Expand
表3.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterRole スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された ClusterRole を部分的に更新する
Expand
表3.9 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表3.10 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterRole スキーマ

201 - Created

ClusterRole スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された ClusterRole を置き換えます。
Expand
表3.11 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表3.12 本文パラメーター
パラメーター説明

body

ClusterRole スキーマ

 
Expand
表3.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterRole スキーマ

201 - Created

ClusterRole スキーマ

401 - Unauthorized

空白

第4章 RoleBindingRestriction [authorization.openshift.io/v1]

説明

RoleBindingRestriction は、サブジェクト (ユーザー、グループ、またはサービスアカウント) と照合して、そのサブジェクトのロールバインディングが RoleBindingRestriction が属する namespace で許可されているかどうかを判断できるオブジェクトです。これらの RoleBindingRestriction オブジェクトのいずれかがサブジェクトと一致する場合は、namespace 内のそのサブジェクトに対するロールバインディングが許可されます。

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

object

4.1. 仕様

Expand
プロパティー説明

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

標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

spec

object

spec はマッチャーを定義します。

4.1.1. .spec

説明
spec はマッチャーを定義します。
object
Expand
プロパティー説明

grouprestriction

``

grouprestriction はグループサブジェクトと一致します。

serviceaccountrestriction

``

serviceaccountrestriction は、サービスアカウントのサブジェクトと一致します。

userrestriction

``

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 のオブジェクトをリスト表示する
Expand
表4.1 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleBindingRestrictionList スキーマ

401 - Unauthorized

空白

4.2.2. /apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindingrestrictions

HTTP メソッド
DELETE
説明
RoleBindingRestriction のコレクションを削除する
Expand
表4.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類 RoleBindingRestriction のオブジェクトをリスト表示する
Expand
表4.3 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleBindingRestrictionList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
RoleBindingRestriction を作成します。
Expand
表4.4 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表4.5 本文パラメーター
パラメーター説明

body

RoleBindingRestriction スキーマ

 
Expand
表4.6 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleBindingRestriction スキーマ

201 - Created

RoleBindingRestriction スキーマ

202 - Accepted

RoleBindingRestriction スキーマ

401 - Unauthorized

空白

4.2.3. /apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindingrestrictions/{name}

Expand
表4.7 グローバルパスパラメーター
パラメーター説明

name

string

RoleBindingRestriction の名前

HTTP メソッド
DELETE
説明
RoleBindingRestriction を削除します。
Expand
表4.8 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表4.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された RoleBindingRestriction を読み取る
Expand
表4.10 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleBindingRestriction スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された RoleBindingRestriction を部分的に更新する
Expand
表4.11 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表4.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleBindingRestriction スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された RoleBindingRestriction を置き換える
Expand
表4.13 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表4.14 本文パラメーター
パラメーター説明

body

RoleBindingRestriction スキーマ

 
Expand
表4.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleBindingRestriction スキーマ

201 - Created

RoleBindingRestriction スキーマ

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. 仕様

Expand
プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

groupNames

array (string)

groupNames は、ロールに直接バインドされているすべてのグループを保持します。このフィールドは、レガシークライアントおよびサーバーをサポートする場合にのみ指定する必要があります。詳細は、主題を参照してください。

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 を参照してください。

roleRef

ObjectReference

roleRef は、現在の namespace とグローバル namespace のみを参照できます。roleRef を解決できない場合は、Authorizer がエラーを返す必要があります。ポリシーはシングルトンであるため、これはロールを見つけるのに十分な知識です。

subjects

array (ObjectReference)

subjects は、このルールで承認するためのオブジェクト参照を保持します。UserNames または GroupNames がレガシークライアントおよびサーバーをサポートするように指定されていると、このフィールドは無視されます。したがって、下位互換性をサポートする必要のない新しいクライアントは、完全に修飾されたサブジェクトのみを送信し、UserNames フィールドと GroupNames フィールドを省略する必要があります。下位互換性をサポートする必要があるクライアントは、このフィールドを使用して UserNames と GroupNames を作成できます。

userNames

array (string)

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 のオブジェクトをリスト表示します。
Expand
表5.1 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleBindingList スキーマ

401 - Unauthorized

空白

5.2.2. /apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindings

HTTP メソッド
GET
説明
種類が RoleBinding のオブジェクトをリスト表示します。
Expand
表5.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleBindingList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
RoleBinding を作成します。
Expand
表5.3 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表5.4 本文パラメーター
パラメーター説明

body

RoleBinding スキーマ

 
Expand
表5.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleBinding スキーマ

201 - Created

RoleBinding スキーマ

202 - Accepted

RoleBinding スキーマ

401 - Unauthorized

空白

5.2.3. /apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindings/{name}

Expand
表5.6 グローバルパスパラメーター
パラメーター説明

name

string

RoleBinding の名前

HTTP メソッド
DELETE
説明
RoleBinding を削除します。
Expand
表5.7 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表5.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status_v3 スキーマ

202 - Accepted

Status_v3 スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された RoleBinding を読み取る
Expand
表5.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleBinding スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された RoleBinding を部分的に更新する
Expand
表5.10 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表5.11 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleBinding スキーマ

201 - Created

RoleBinding スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された RoleBinding を置き換える
Expand
表5.12 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表5.13 本文パラメーター
パラメーター説明

body

RoleBinding スキーマ

 
Expand
表5.14 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleBinding スキーマ

201 - Created

RoleBinding スキーマ

401 - Unauthorized

空白

第6章 Role [authorization.openshift.io/v1]

説明

Role は、RoleBindings が 1 つの単位として参照できる PolicyRules の論理グループです。

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

object
必須
  • rules

6.1. 仕様

Expand
プロパティー説明

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 を参照してください。

rules

array

rules は、この Role のすべての PolicyRules を保持します。

rules[]

object

PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。

6.1.1. .rules

説明
rules は、この Role のすべての PolicyRules を保持します。
array

6.1.2. .rules[]

説明
PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。
object
必須
  • verbs
  • resources
Expand
プロパティー説明

apiGroups

array (string)

apiGroups は、リソースを含む APIGroup の名前です。このフィールドが空の場合は、kubernetes と origin API グループの両方が想定されます。つまり、kubernetes またはオリジン API グループのいずれかで列挙されたリソースのいずれかに対してアクションがリクエストされると、そのリクエストは許可されます。

attributeRestrictions

RawExtension

attributeRestrictions は、Authorizer/AuthorizationAttributeBuilder ペアがサポートするものに応じて異なります。authorizer が AttributeRestrictions の処理方法を認識しないと、authorizer がエラーを報告します。

nonResourceURLs

array (string)

nonResourceURLsSlice は、ユーザーがアクセスできる必要のある部分的な URL のセットです。* は許可されますが、パスの完全な最終ステップとしてのみこの名前は内部タイプとは意図的に異なります。これにより、DefaultConvert が適切に機能し、順序が異なる場合があります。

resourceNames

array (string)

resourceNames は、ルールが適用される名前のオプションのホワイトリストです。空のセットは、すべてが許可されていることを意味します。

resources

array (string)

resources は、このルールが適用されるリソースのリストです。resourceAll は、すべてのリソースを表します。

verbs

array (string)

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 のオブジェクトをリスト表示する
Expand
表6.1 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleList スキーマ

401 - Unauthorized

空白

6.2.2. /apis/authorization.openshift.io/v1/namespaces/{namespace}/roles

HTTP メソッド
GET
説明
種類 Role のオブジェクトをリスト表示する
Expand
表6.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RoleList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
Role を作成します。
Expand
表6.3 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表6.4 本文パラメーター
パラメーター説明

body

Role スキーマ

 
Expand
表6.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Role スキーマ

201 - Created

Role スキーマ

202 - Accepted

Role スキーマ

401 - Unauthorized

空白

6.2.3. /apis/authorization.openshift.io/v1/namespaces/{namespace}/roles/{name}

Expand
表6.6 グローバルパスパラメーター
パラメーター説明

name

string

Role の名前です。

HTTP メソッド
DELETE
説明
Role を削除します。
Expand
表6.7 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表6.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status_v3 スキーマ

202 - Accepted

Status_v3 スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された Role を読み取る
Expand
表6.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Role スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された Role を部分的に更新する
Expand
表6.10 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表6.11 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Role スキーマ

201 - Created

Role スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された Role を置き換えます。
Expand
表6.12 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表6.13 本文パラメーター
パラメーター説明

body

Role スキーマ

 
Expand
表6.14 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Role スキーマ

201 - Created

Role スキーマ

401 - Unauthorized

空白

Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

会社概要

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

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

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

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

Legal Notice

Theme

© 2026 Red Hat
トップに戻る