OAuth API

第1章 OAuth API

1.1. OAuthAccessToken [oauth.openshift.io/v1]

説明

OAuthAccessToken は、OAuth アクセストークンを説明します。トークンの名前には sha256~ 文字列の接頭辞が付けられ、"/" または "%" 文字が含まれてはならず、少なくとも 32 文字の長さである必要があります。

トークンの名前は、実際のトークンを sha256 でハッシュし、ハッシュ結果に対して URL セーフなパディングなしの base64 エンコーディング (RFC4648 で説明) を使用して構築されます。

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

型

object

1.2. OAuthAuthorizeToken [oauth.openshift.io/v1]

説明

OAuthAuthorizeToken は、OAuth 認証トークンを説明する

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

型

object

1.3. OAuthClientAuthorization [oauth.openshift.io/v1]

説明

OAuthClientAuthorization は、OAuth クライアントが作成する承認を説明する

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

型

object

1.4. OAuthClient [oauth.openshift.io/v1]

説明

OAuthClient は OAuth クライアントを説明する

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

型

object

1.5. UserOAuthAccessToken [oauth.openshift.io/v1]

説明: UserOAuthAccessToken は、アクセストークンが発行されたユーザーに OAuthAccessToken をミラーリングするための仮想リソースです。
型: object

第2章 OAuthAccessToken [oauth.openshift.io/v1]

説明

OAuthAccessToken は、OAuth アクセストークンを説明します。トークンの名前には sha256~ 文字列の接頭辞が付けられ、"/" または "%" 文字が含まれてはならず、少なくとも 32 文字の長さである必要があります。

トークンの名前は、実際のトークンを sha256 でハッシュし、ハッシュ結果に対して URL セーフなパディングなしの base64 エンコーディング (RFC4648 で説明) を使用して構築されます。

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

型

object

2.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`authorizeToken`	`string`	AuthorizeToken には、このトークンを承認したトークンが含まれています
`clientName`	`string`	ClientName は、このトークンを作成したクライアントを参照します。
`expiresIn`	`integer`	ExpiresIn は、CreationTime からこのトークンが期限切れになるまでの秒数です。
`inactivityTimeoutSeconds`	`integer`	InactivityTimeoutSeconds は、CreationTimestamp からの秒単位の値であり、それ以降、このトークンは使用できなくなります。トークンが使用されると、値は自動的にインクリメントされます。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta`	metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`redirectURI`	`string`	RedirectURI は、トークンに関連付けられたリダイレクトです。
`refreshToken`	`string`	RefreshToken は、このトークンを更新できる値です。空白にできます。
`scopes`	`array (string)`	スコープは、要求されたスコープの配列です。
`userName`	`string`	UserName は、このトークンに関連付けられているユーザー名です。
`userUID`	`string`	UserUID は、このトークンに関連付けられた一意の UID です。

2.2. API エンドポイント

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

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

2.2.1. /apis/oauth.openshift.io/v1/oauthaccesstokens

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

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

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

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

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

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

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

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

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

2.2.2. /apis/oauth.openshift.io/v1/watch/oauthaccesstokens

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

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

2.2.3. /apis/oauth.openshift.io/v1/oauthaccesstokens/{name}

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

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

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

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

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

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

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

表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	`OAuthAccessToken` スキーマ
201 - Created	`OAuthAccessToken` スキーマ
401 - Unauthorized	空白

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

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

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

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

2.2.4. /apis/oauth.openshift.io/v1/watch/oauthaccesstokens/{name}

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

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

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

第3章 OAuthAuthorizeToken [oauth.openshift.io/v1]

説明

OAuthAuthorizeToken は、OAuth 認証トークンを説明する

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

型

object

3.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`clientName`	`string`	ClientName は、このトークンを作成したクライアントを参照します。
`codeChallenge`	`string`	CodeChallenge は、rfc7636 で説明されているように、この認証コードに関連付けられたオプションの code_challenge です。
`codeChallengeMethod`	`string`	CodeChallengeMethod は、rfc7636 で説明されているように、この認証コードに関連付けられたオプションの code_challenge_method です。
`expiresIn`	`integer`	ExpiresIn は、CreationTime からこのトークンが期限切れになるまでの秒数です。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta`	metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`redirectURI`	`string`	RedirectURI は、トークンに関連付けられたリダイレクトです。
`scopes`	`array (string)`	スコープは、要求されたスコープの配列です。
`state`	`string`	リクエストからの状態データ
`userName`	`string`	UserName は、このトークンに関連付けられているユーザー名です。
`userUID`	`string`	UserUID は、このトークンに関連付けられた一意の UID です。このトークンを有効にするには、UserUID と UserName の両方が一致している必要があります。

3.2. API エンドポイント

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

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

3.2.1. /apis/oauth.openshift.io/v1/oauthauthorizetokens

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

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

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

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

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

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

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

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

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

3.2.2. /apis/oauth.openshift.io/v1/watch/oauthauthorizetokens

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

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

3.2.3. /apis/oauth.openshift.io/v1/oauthauthorizetokens/{name}

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

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

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

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

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

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

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

表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	`OAuthAuthorizeToken` スキーマ
201 - Created	`OAuthAuthorizeToken` スキーマ
401 - Unauthorized	空白

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

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

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

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

3.2.4. /apis/oauth.openshift.io/v1/watch/oauthauthorizetokens/{name}

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

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

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

第4章 OAuthClientAuthorization [oauth.openshift.io/v1]

説明

OAuthClientAuthorization は、OAuth クライアントが作成する承認を説明する

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

型

object

4.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`clientName`	`string`	ClientName は、この承認を作成したクライアントを参照します。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta`	metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`scopes`	`array (string)`	スコープは、付与されたスコープの配列です。
`userName`	`string`	UserName は、このクライアントを承認したユーザー名です
`userUID`	`string`	UserUID は、この認証に関連付けられた一意の UID です。この認証を有効にするには、UserUID と UserName の両方が一致している必要があります。

4.2. API エンドポイント

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

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

4.2.1. /apis/oauth.openshift.io/v1/oauthclientauthorizations

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

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

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

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

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

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

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

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

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

4.2.2. /apis/oauth.openshift.io/v1/watch/oauthclientauthorizations

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

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

4.2.3. /apis/oauth.openshift.io/v1/oauthclientauthorizations/{name}

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

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

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

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

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

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

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

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

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

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

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

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

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

4.2.4. /apis/oauth.openshift.io/v1/watch/oauthclientauthorizations/{name}

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

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

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

第5章 OAuthClient [oauth.openshift.io/v1]

説明

OAuthClient は OAuth クライアントを説明する

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

型

object

5.1. 仕様

プロパティー	型	説明
`accessTokenInactivityTimeoutSeconds`	`integer`	AccessTokenInactivityTimeoutSeconds は、このクライアントに付与されたトークンのデフォルトのトークン非アクティブタイムアウトをオーバーライドします。この値は、トークンを連続して使用する間に発生する可能性のある最大時間を表します。トークンがこの一時ウィンドウ内で使用されないと、トークンは無効になります。トークンがタイムアウトしたときにアクセスを回復するには、ユーザーが新しいトークンを取得する必要があります。この値を設定する必要があるのは、設定で設定されているデフォルトがこのクライアントに適していない場合のみです。有効な値は次のとおりです。-0: このクライアントのトークンはタイムアウトしません。-X: X 秒間アクティビティーがないと、トークンはタイムアウトします。X の現在の最小許容値は 300 (5 分) です警告: この値を変更しても、既存のトークンのタイムアウトは影響を受けません (低下します)。
`accessTokenMaxAgeSeconds`	`integer`	AccessTokenMaxAgeSeconds は、このクライアントに付与されたトークンのデフォルトのアクセストークンの最大経過時間を上書きします。0 は有効期限がないことを意味します。
`additionalSecrets`	`array (string)`	AdditionalSecrets は、クライアントを識別するために使用される可能性のある他のシークレットを保持します。これは、ローテーションやサービスアカウントトークンの検証に役立ちます
`apiVersion`	`string`	apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`grantMethod`	`string`	GrantMethod は、このクライアントの許可を処理する方法を決定する必須フィールドです。有効な許可処理方法は次のとおりです。--auto: 常に許可要求を承認します。信頼できるクライアントに役立ちます。--prompt: エンドユーザーに許可要求の承認を求めます。サードパーティーのクライアントに役立ちます。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta`	metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`redirectURIs`	`array (string)`	RedirectURIs は、クライアントに関連付けられた有効なリダイレクト URI です。
`respondWithChallenges`	`boolean`	RespondWithChallenges は、クライアントがリダイレクトではなくチャレンジの形で行われる認証に必要な応答を望んでいるかどうかを示します
`scopeRestrictions`	`array`	ScopeRestrictions は、このクライアントが要求できるスコープを記述します。要求された各スコープは、各制限に対してチェックされます。いずれかの制限が一致すると、スコープが許可されます。一致する制限がないと、スコープが拒否されます。
`scopeRestrictions[]`	`object`	ScopeRestriction は、スコープに対する 1 つの制限を記述します。必ず 1 つのオプションを nil 以外にする必要があります。
`secret`	`string`	シークレットは、クライアントに関連付けられた一意のシークレットです

5.1.1. .scopeRestrictions

説明: ScopeRestrictions は、このクライアントが要求できるスコープを記述します。要求された各スコープは、各制限に対してチェックされます。いずれかの制限が一致すると、スコープが許可されます。一致する制限がないと、スコープが拒否されます。
型: array

5.1.2. .scopeRestrictions[]

説明: ScopeRestriction は、スコープに対する 1 つの制限を記述します。必ず 1 つのオプションを nil 以外にする必要があります。
型: object

プロパティー	型	説明
`clusterRole`	`object`	ClusterRoleScopeRestriction は、クラスターロールスコープの制限を説明します。
`literals`	`array (string)`	ExactValues は、スコープが特定の文字列セットと正確に一致する必要があることを意味します。

5.1.3. .scopeRestrictions[].clusterRole

説明

ClusterRoleScopeRestriction は、クラスターロールスコープの制限を説明する

型

object

必須

roleNames
namespace
allowEscalation

プロパティー	型	説明
`allowEscalation`	`boolean`	AllowEscalation は、ロールとそのエスカレートするリソースをリクエストできるかどうかを示します。
`namespace`	`array (string)`	名前空間は、参照できる名前空間のリストです。* はそれらのいずれかを意味します (* を含む)
`roleNames`	`array (string)`	RoleNames は、参照できるクラスターロールのリストです。* は、すべてを意味します。

5.2. API エンドポイント

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

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

5.2.1. /apis/oauth.openshift.io/v1/oauthclients

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

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

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

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

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

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

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

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

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

5.2.2. /apis/oauth.openshift.io/v1/watch/oauthclients

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

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

5.2.3. /apis/oauth.openshift.io/v1/oauthclients/{name}

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

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

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

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

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

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

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

表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	`OAuthClient` スキーマ
201 - Created	`OAuthClient` スキーマ
401 - Unauthorized	空白

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

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

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

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

5.2.4. /apis/oauth.openshift.io/v1/watch/oauthclients/{name}

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

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

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

第6章 UserOAuthAccessToken [oauth.openshift.io/v1]

説明: UserOAuthAccessToken は、アクセストークンが発行されたユーザーに OAuthAccessToken をミラーリングするための仮想リソースです。
型: object

6.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`authorizeToken`	`string`	AuthorizeToken には、このトークンを承認したトークンが含まれています
`clientName`	`string`	ClientName は、このトークンを作成したクライアントを参照します。
`expiresIn`	`integer`	ExpiresIn は、CreationTime からこのトークンが期限切れになるまでの秒数です。
`inactivityTimeoutSeconds`	`integer`	InactivityTimeoutSeconds は、CreationTimestamp からの秒単位の値であり、それ以降、このトークンは使用できなくなります。トークンが使用されると、値は自動的にインクリメントされます。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta`	metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`redirectURI`	`string`	RedirectURI は、トークンに関連付けられたリダイレクトです。
`refreshToken`	`string`	RefreshToken は、このトークンを更新できる値です。空白にできます。
`scopes`	`array (string)`	スコープは、要求されたスコープの配列です。
`userName`	`string`	UserName は、このトークンに関連付けられているユーザー名です。
`userUID`	`string`	UserUID は、このトークンに関連付けられた一意の UID です。

6.2. API エンドポイント

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

/apis/oauth.openshift.io/v1/useroauthaccesstokens
- GET: UserOAuthAccessToken の種類のオブジェクトをリスト表示または監視する
/apis/oauth.openshift.io/v1/watch/useroauthaccesstokens
- GET: UserOAuthAccessToken のリストに対する個々の変更を監視する。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/apis/oauth.openshift.io/v1/useroauthaccesstokens/{name}
- DELETE: UserOAuthAccessToken を削除する
- GET: 指定された UserOAuthAccessToken を読み取る
/apis/oauth.openshift.io/v1/watch/useroauthaccesstokens/{name}
- GET: UserOAuthAccessToken の種類のオブジェクトへの変更を監視する。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

6.2.1. /apis/oauth.openshift.io/v1/useroauthaccesstokens

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

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

6.2.2. /apis/oauth.openshift.io/v1/watch/useroauthaccesstokens

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

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

6.2.3. /apis/oauth.openshift.io/v1/useroauthaccesstokens/{name}

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

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

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

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

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

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

6.2.4. /apis/oauth.openshift.io/v1/watch/useroauthaccesstokens/{name}

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

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

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

Oauth API リファレンスガイド

第1章 OAuth API

1.1. OAuthAccessToken [oauth.openshift.io/v1]

1.2. OAuthAuthorizeToken [oauth.openshift.io/v1]

1.3. OAuthClientAuthorization [oauth.openshift.io/v1]

1.4. OAuthClient [oauth.openshift.io/v1]

1.5. UserOAuthAccessToken [oauth.openshift.io/v1]

第2章 OAuthAccessToken [oauth.openshift.io/v1]

2.1. 仕様

2.2. API エンドポイント

2.2.1. /apis/oauth.openshift.io/v1/oauthaccesstokens

2.2.2. /apis/oauth.openshift.io/v1/watch/oauthaccesstokens

2.2.3. /apis/oauth.openshift.io/v1/oauthaccesstokens/{name}

2.2.4. /apis/oauth.openshift.io/v1/watch/oauthaccesstokens/{name}

第3章 OAuthAuthorizeToken [oauth.openshift.io/v1]

3.1. 仕様

3.2. API エンドポイント

3.2.1. /apis/oauth.openshift.io/v1/oauthauthorizetokens

3.2.2. /apis/oauth.openshift.io/v1/watch/oauthauthorizetokens

3.2.3. /apis/oauth.openshift.io/v1/oauthauthorizetokens/{name}

3.2.4. /apis/oauth.openshift.io/v1/watch/oauthauthorizetokens/{name}

第4章 OAuthClientAuthorization [oauth.openshift.io/v1]

4.1. 仕様

4.2. API エンドポイント

4.2.1. /apis/oauth.openshift.io/v1/oauthclientauthorizations

4.2.2. /apis/oauth.openshift.io/v1/watch/oauthclientauthorizations

4.2.3. /apis/oauth.openshift.io/v1/oauthclientauthorizations/{name}

4.2.4. /apis/oauth.openshift.io/v1/watch/oauthclientauthorizations/{name}

第5章 OAuthClient [oauth.openshift.io/v1]

5.1. 仕様

5.1.1. .scopeRestrictions

5.1.2. .scopeRestrictions[]

5.1.3. .scopeRestrictions[].clusterRole

5.2. API エンドポイント

5.2.1. /apis/oauth.openshift.io/v1/oauthclients

5.2.2. /apis/oauth.openshift.io/v1/watch/oauthclients

5.2.3. /apis/oauth.openshift.io/v1/oauthclients/{name}

5.2.4. /apis/oauth.openshift.io/v1/watch/oauthclients/{name}

第6章 UserOAuthAccessToken [oauth.openshift.io/v1]

6.1. 仕様

6.2. API エンドポイント

6.2.1. /apis/oauth.openshift.io/v1/useroauthaccesstokens

6.2.2. /apis/oauth.openshift.io/v1/watch/useroauthaccesstokens

6.2.3. /apis/oauth.openshift.io/v1/useroauthaccesstokens/{name}

6.2.4. /apis/oauth.openshift.io/v1/watch/useroauthaccesstokens/{name}

Legal Notice

詳細情報

試用、購入および販売

コミュニティー

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

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

会社概要

Red Hat legal and privacy links

Red Hat legal and privacy links