Red Hat SummitOAuth API
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 はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| authorizeToken には、このトークンを認可したトークンが含まれています。 |
|
|
| clientName は、このトークンを作成したクライアントを参照します。 |
|
|
| expiresIn は、CreationTime からこのトークンが失効するまでの秒数です。 |
|
|
| inactivityTimeoutSeconds は、CreationTimestamp からの秒数で、この時間が経過するとトークンは使用できなくなります。トークンが使用されると、値は自動的にインクリメントされます。 |
|
|
| 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 を参照してください。 | |
|
|
| redirectURI は、トークンに関連付けられたリダイレクトです。 |
|
|
| refreshToken は、このトークンを更新できる値です。空白にできます。 |
|
|
| scopes は、要求されたスコープの配列です。 |
|
|
| userName は、このトークンに関連付けられているユーザー名です。 |
|
|
| 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 のコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が OAuthAccessToken のオブジェクトをリスト表示または監視します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- OAuthAccessToken を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。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/oauth.openshift.io/v1/watch/oauthaccesstokens
- HTTP メソッド
-
GET - 説明
- OAuthAccessToken のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
2.2.3. /apis/oauth.openshift.io/v1/oauthaccesstokens/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| OAuthAccessToken の名前 |
- HTTP メソッド
-
DELETE - 説明
- OAuthAccessToken を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された OAuthAccessToken を読み取る
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された OAuthAccessToken を部分的に更新する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された OAuthAccessToken を置き換える
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
2.2.4. /apis/oauth.openshift.io/v1/watch/oauthaccesstokens/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| OAuthAccessToken の名前 |
- HTTP メソッド
-
GET - 説明
- 種類が OAuthAccessToken のオブジェクトへの変更を監視する。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
第3章 OAuthAuthorizeToken [oauth.openshift.io/v1]
- 説明
OAuthAuthorizeToken は、OAuth 認証トークンを説明する
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
3.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| clientName は、このトークンを作成したクライアントを参照します。 |
|
|
| codeChallenge は、rfc7636 で説明されているように、この認可コードに関連付けられたオプションの code_challenge です。 |
|
|
| codeChallengeMethod は、rfc7636 で説明されているように、この認可コードに関連付けられたオプションの code_challenge_method です。 |
|
|
| expiresIn は、CreationTime からこのトークンが失効するまでの秒数です。 |
|
|
| 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 を参照してください。 | |
|
|
| redirectURI は、トークンに関連付けられたリダイレクトです。 |
|
|
| scopes は、要求されたスコープの配列です。 |
|
|
| リクエストからの状態データ |
|
|
| userName は、このトークンに関連付けられているユーザー名です。 |
|
|
| 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 のコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が OAuthAuthorizeToken のオブジェクトをリスト表示または監視します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- OAuthAuthorizeToken を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。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/oauth.openshift.io/v1/watch/oauthauthorizetokens
- HTTP メソッド
-
GET - 説明
- OAuthAuthorizeToken のリストに対する個々の変更を監視する。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
3.2.3. /apis/oauth.openshift.io/v1/oauthauthorizetokens/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| OAuthAuthorizeToken の名前 |
- HTTP メソッド
-
DELETE - 説明
- OAuthAuthorizeToken を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された OAuthAuthorizeToken を読み取る
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された OAuthAuthorizeToken を部分的に更新する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された OAuthAuthorizeToken を置き換える
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
3.2.4. /apis/oauth.openshift.io/v1/watch/oauthauthorizetokens/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| OAuthAuthorizeToken の名前 |
- HTTP メソッド
-
GET - 説明
- 種類が OAuthAuthorizeToken のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
第4章 OAuthClientAuthorization [oauth.openshift.io/v1]
- 説明
OAuthClientAuthorization は、OAuth クライアントが作成する認可を記述します。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
4.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| clientName は、この認可を作成したクライアントを参照します。 |
|
|
| 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 を参照してください。 | |
|
|
| scopes は、付与されたスコープの配列です。 |
|
|
| userName は、このクライアントを認可したユーザー名です。 |
|
|
| 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 のコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が OAuthClientAuthorization のオブジェクトをリスト表示または監視します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- OAuthClientAuthorization を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。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.2. /apis/oauth.openshift.io/v1/watch/oauthclientauthorizations
- HTTP メソッド
-
GET - 説明
- OAuthClientAuthorization のリストに対する個々の変更を監視する。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
4.2.3. /apis/oauth.openshift.io/v1/oauthclientauthorizations/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| OAuthClientAuthorization の名前 |
- HTTP メソッド
-
DELETE - 説明
- OAuthClientAuthorization を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された OAuthClientAuthorization を読み取る
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された OAuthClientAuthorization を部分的に更新する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された OAuthClientAuthorization を置き換える
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空白 |
4.2.4. /apis/oauth.openshift.io/v1/watch/oauthclientauthorizations/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| OAuthClientAuthorization の名前 |
- HTTP メソッド
-
GET - 説明
- 種類が OAuthClientAuthorization のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
第5章 OAuthClient [oauth.openshift.io/v1]
- 説明
OAuthClient は OAuth クライアントを説明する
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
5.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| accessTokenInactivityTimeoutSeconds は、このクライアントに付与されたトークンのデフォルトのトークン非アクティブタイムアウトをオーバーライドします。この値は、トークンを連続して使用する間に発生する可能性のある最大時間を表します。トークンがこの一時ウィンドウ内で使用されないと、トークンは無効になります。トークンがタイムアウトしたときにアクセスを回復するには、ユーザーが新しいトークンを取得する必要があります。この値を設定する必要があるのは、設定で設定されているデフォルトがこのクライアントに適していない場合のみです。有効な値は次のとおりです。-0: このクライアントのトークンはタイムアウトしません。-X: X 秒間アクティビティーがないと、トークンはタイムアウトします。X の現在の最小許容値は 300 (5 分) です 警告: この値を変更しても、既存のトークンのタイムアウトは影響を受けません (低下します)。 |
|
|
| accessTokenMaxAgeSeconds は、このクライアントに付与されたトークンのデフォルトのアクセストークンの最大経過時間をオーバーライドします。0 は有効期限がないことを意味します。 |
|
|
| additionalSecrets は、クライアントを識別するために使用される可能性のある他のシークレットを保持します。これは、ローテーションやサービスアカウントトークンの検証に役立ちます |
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| grantMethod は、このクライアントの付与を処理する方法を決定する必須フィールドです。有効な付与処理方法は次のとおりです。--auto: 常に付与要求を承認します。信頼できるクライアントに役立ちます。--prompt: エンドユーザーに付与要求の承認を求めます。サードパーティーのクライアントに役立ちます。 |
|
|
| 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 を参照してください。 | |
|
|
| redirectURIs は、クライアントに関連付けられた有効なリダイレクト URI です。 |
|
|
| respondWithChallenges は、クライアントが認証を要求する応答を、リダイレクトではなくチャレンジの形式で受け取ることを望むかどうかを示します。 |
|
|
| scopeRestrictions は、このクライアントが要求できるスコープを記述します。要求された各スコープは、各制限に対してチェックされます。いずれかの制限が一致すると、スコープが許可されます。一致する制限がないと、スコープが拒否されます。 |
|
|
| ScopeRestriction は、スコープに対する 1 つの制限を記述します。必ず 1 つのオプションを nil 以外にする必要があります。 |
|
|
| secret は、クライアントに関連付けられた一意のシークレットです。 |
5.1.1. .scopeRestrictions
- 説明
- scopeRestrictions は、このクライアントが要求できるスコープを記述します。要求された各スコープは、各制限に対してチェックされます。いずれかの制限が一致すると、スコープが許可されます。一致する制限がないと、スコープが拒否されます。
- 型
-
array
5.1.2. .scopeRestrictions[]
- 説明
- ScopeRestriction は、スコープに対する 1 つの制限を記述します。必ず 1 つのオプションを nil 以外にする必要があります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ClusterRoleScopeRestriction は、クラスターロールスコープの制限を説明します。 |
|
|
| ExactValues は、スコープが特定の文字列セットと正確に一致する必要があることを意味します。 |
5.1.3. .scopeRestrictions[].clusterRole
- 説明
- ClusterRoleScopeRestriction は、クラスターロールスコープの制限を説明します。
- 型
-
object - 必須
-
roleNames -
namespaces -
allowEscalation
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| allowEscalation は、ロールとそのエスカレートするリソースを要求できるかどうかを示します。 |
|
|
| namespaces は、参照できる namespaces のリストです。* はそれらのいずれかを意味します (* を含む) |
|
|
| 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 のコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- OAuthClient の種類のオブジェクトをリスト表示または監視する
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- OAuthClient を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。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.2. /apis/oauth.openshift.io/v1/watch/oauthclients
- HTTP メソッド
-
GET - 説明
- OAuthClient のリストに対する個々の変更を監視する。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
5.2.3. /apis/oauth.openshift.io/v1/oauthclients/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| OAuthClient の名前 |
- HTTP メソッド
-
DELETE - 説明
- OAuthClient を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された OAuthClient を読み取る
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された OAuthClient を部分的に更新する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された OAuthClient を置き換える
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
5.2.4. /apis/oauth.openshift.io/v1/watch/oauthclients/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| OAuthClient の名前 |
- HTTP メソッド
-
GET - 説明
- OAuthClient の種類のオブジェクトへの変更を監視する。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
第6章 UserOAuthAccessToken [oauth.openshift.io/v1]
- 説明
- UserOAuthAccessToken は、アクセストークンが発行されたユーザーに OAuthAccessToken をミラーリングするための仮想リソースです。
- 型
-
object
6.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| authorizeToken には、このトークンを認可したトークンが含まれています。 |
|
|
| clientName は、このトークンを作成したクライアントを参照します。 |
|
|
| expiresIn は、CreationTime からこのトークンが失効するまでの秒数です。 |
|
|
| inactivityTimeoutSeconds は、CreationTimestamp からの秒数で、この時間が経過するとトークンは使用できなくなります。トークンが使用されると、値は自動的にインクリメントされます。 |
|
|
| 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 を参照してください。 | |
|
|
| redirectURI は、トークンに関連付けられたリダイレクトです。 |
|
|
| refreshToken は、このトークンを更新できる値です。空白にできます。 |
|
|
| scopes は、要求されたスコープの配列です。 |
|
|
| userName は、このトークンに関連付けられているユーザー名です。 |
|
|
| 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 の種類のオブジェクトをリスト表示または監視する
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
6.2.2. /apis/oauth.openshift.io/v1/watch/useroauthaccesstokens
- HTTP メソッド
-
GET - 説明
- UserOAuthAccessToken のリストに対する個々の変更を監視する。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
6.2.3. /apis/oauth.openshift.io/v1/useroauthaccesstokens/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| UserOAuthAccessToken の名前 |
- HTTP メソッド
-
DELETE - 説明
- UserOAuthAccessToken を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された UserOAuthAccessToken を読み取る
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
6.2.4. /apis/oauth.openshift.io/v1/watch/useroauthaccesstokens/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| UserOAuthAccessToken の名前 |
- HTTP メソッド
-
GET - 説明
- UserOAuthAccessToken の種類のオブジェクトへの変更を監視する。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
Legal Notice
Copyright © 2025 Red Hat
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}