Red Hat Summit5.2. GetAuthProviders
GET /v1/authProviders
5.2.1. 説明
5.2.2. パラメーター
5.2.2.1. クエリーパラメーター
| 名前 | 説明 | 必須 | デフォルト | Pattern |
|---|---|---|---|---|
| name | - | null | ||
| type | - | null |
5.2.3. 戻り値のタイプ
5.2.4. コンテンツタイプ
- application/json
5.2.5. レスポンス
| コード | メッセージ | データタイプ |
|---|---|---|
| 200 | 正常な応答。 | |
| 0 | 予期しないエラーの応答です。 |
5.2.6. サンプル
5.2.7. 共通のオブジェクト参照
5.2.7.1. AuthProviderRequiredAttribute
RequiredAttribute を使用すると、認証プロバイダーによって返される必要がある属性のセットを指定できます。Central が発行するトークンの外部要求内に属性がない場合、この IdP への認証要求は失敗とみなされます。
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| attributeKey | String | ||||
| attributeValue | String |
5.2.7.2. ProtobufAny
any には、シリアライズされたメッセージの型を記述する URL とともに、任意のシリアライズされたプロトコルバッファーメッセージが含まれます。
Protobuf ライブラリーは、パック/アンパックをサポートします。任意の値は、ユーティリティー関数の形式で、または Any タイプの追加の生成されたメソッドになります。
例 1: C++ のメッセージをパックして展開します。
例 2: Java でメッセージをパックして解凍します。
Example 3: Pack and unpack a message in Python.
Example 3: Pack and unpack a message in Python.Example 4: Pack and unpack a message in Go
Example 4: Pack and unpack a message in Goprotobuf ライブラリーが提供するパックメソッドは、デフォルトで type.googleapis.com/full.type.name をタイプ URL として使用し、unzip メソッドは、タイプ URL の最後の//のみを使用します。たとえば、"foo.bar.com/x/y.z" のように、"foo.bar.com/x/y.z" の型名 "y.z" が生成されます。
5.2.7.2.1. JSON 表現
Any 値の JSON 表現は、デシリアライズされた埋め込みメッセージの通常の表現を使用し、タイプ URL が含まれる追加のフィールド @type を使用します。以下に例を示します。
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
埋め込みメッセージタイプがよく知られていて、カスタム JSON 表現がある場合、その表現は埋め込みされ、@type フィールドに加えてカスタム JSON を保持するフィールド 値 が追加されます。例（メッセージ [google.protobuf.Duration][] の場合）:
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| typeUrl | String |
シリアライズされたプロトコルバッファーメッセージのタイプを一意に識別する URL/リソース名。この文字列には最低でも 1 つの \"/\" 文字を含める必要があります。URL のパスの最後のセグメントは、タイプの完全修飾名( | |||
| value | byte[] | 上記の指定されたタイプの有効なシリアライズされたプロトコルバッファーである必要があります。 | byte |
5.2.7.3. RuntimeError
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | ProtobufAnyのリスト |
5.2.7.4. StorageAuthProvider
次のタグ：15
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| id | String | ||||
| name | String | ||||
| type | String | ||||
| uiEndpoint | String | ||||
| enabled | Boolean | ||||
| config |
| Config は認証プロバイダー固有の設定を保持します。各設定オプションは、指定の認証プロバイダータイプによって異なります。OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier に準拠した OIDC 発行者。- \"client_id\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 に準拠したクライアント ID。- \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 に準拠したクライアントシークレットです。- - \"do_not_use_client_secret\": クライアント ID のみで、クライアントシークレットのない設定を作成する場合は \"true\" に設定します。- \"mode\": OIDC コールバックモード、または OIDC コールバックモード。オフライントークンが発行されない場合は、\"fragment\"、\"post\"、または \"query\": \"disable_offline_access_scope\": \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid プロファイル email\" に加えて要求する追加のスコープのスペースで区切られた文字列。OpenShift Auth: 追加の設定オプションをサポートしません。ユーザー PKI: - \"keys\": エンコードされた信頼できる証明書 PEM です。saml: - \"sp_issuer\": https://datatracker.ietf.org/doc/html/rfc7522#section-3. - \"idp_metadata_url\": https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf に準拠したメタデータ URL。- \"idp_issuer\": IdP 発行者。- \"idp_cert_pem\": IdP エンドポイント用にエンコードされた証明書 PEM。- \"idp_sso_url\": IdP SSO URL。- \"idp_nameid_format\": IdP 名 ID 形式。IAP: - \"audience\": 使用するオーディエンス。 | |||
| loginUrl | String | ログイン URL はバックエンドにより提供され、リクエストで指定できない場合があります。 | |||
| validated | Boolean | ||||
| extraUiEndpoints |
|
| |||
| active | Boolean | ||||
| requiredAttributes | |||||
| traits | |||||
| claimMappings |
| Rox トークン属性にコピーされる IdP トークンからの要求を指定します。このマップの各キーには、マップする IdP トークンのパスが含まれています。パスは \".\" 記号で区切られます。たとえば、IdP トークンペイロードが { \"a\": { \"b\" : \"c\", \"d\": true, \"e\": [ \"val1\", \"val2\", \"val3\" ], \"f\": [ true, false, false ], \"g\", 123.0, \"h\": [ 1、2, 3] } } で、\"a.b\" は有効なキーになり、\"a.z\" は有効ではありません。次のタイプの要求をサポートしています：* string (path \"a.b\")* bool (path \"a.d\")* string array (path \"a.e\")* bool array (path \"a.f.\")* float/integer claim (path \"a.g\")* float/integer array claims (path \"a.h\")）このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、value が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記：この機能は OIDC 認証プロバイダーに対してのみサポートされます。 | |||
| lastUpdated | Date | Last updated は、認証プロバイダーが最後に更新された時刻を示します。このタイムスタンプの 前 に認証プロバイダーによって発行されたトークンがあった場合、無効なと見なされます。その後、すべてのクライアントはトークンを再発行する必要があります（更新または追加のログイン試行のいずれか）。 | date-time |
5.2.7.5. StorageTraits
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| mutabilityMode | ALLOW_MUTATE, ALLOW_MUTATE_FORCED, | ||||
| visibility | VISIBLE、HIDDEN、 | ||||
| origin | 命令、デフォルト、宣言的、DECLARATIVE_ORPHANED |
5.2.7.6. TraitsMutabilityMode
実験的注記：当面は、MutabilityMode の使用を参照してください。これは今後置き換えられる予定です(ROX-14276)。MutabilityMode は、オブジェクトを変更するかどうか、およびその方法を指定します。デフォルトは ALLOW_MUTATE であり、変更制限がないことを意味します。これは、MutabilityMode 仕様がないことと同等です。ALLOW_MUTATE_FORCED は、force ビットでのオブジェクト削除以外のすべての変更操作を禁止します。
このフィールドの状態を変更するときは注意してください。たとえば、オブジェクトを ALLOW_MUTATE から ALLOW_MUTATE_FORCED に変更することは許可されますが、これを変更すると、ALLOW_MUTATE に戻すなど、それ以降の変更はできなくなります。
| Enum 値 |
|---|
| ALLOW_MUTATE |
| ALLOW_MUTATE_FORCED |
5.2.7.7. TraitsOrigin
origin は、オブジェクトの発信元を指定します。オブジェクトには、発信元を 4 つ持つことができます：- IMPERATIVE: オブジェクトは API 経由で作成されました。これはデフォルトで仮定されます。- DEFAULT: オブジェクトは、デフォルトのロール、アクセススコープなどのデフォルトオブジェクトです。DECLARATIVE: オブジェクトは宣言型設定を使用して作成されます。- DECLARATIVE_ORPHANED: オブジェクトは宣言型設定によって作成され、（たとえば、別のオブジェクトで参照されるため）作成元に基づいて別のルールがオブジェクトに適用されます。DECLARATIVE オリジンを持つオブジェクトは、宣言的設定を介してのみ API 経由で変更することはできません。さらに、IMPERATIVE オリジンを使用してオブジェクトを参照することはできません。DEFAULT オリジンを持つオブジェクトは、API または宣言型設定のいずれかを介して変更することはできません。それらは他のすべてのオブジェクトで参照できます。IMPERATIVE オリジンを持つオブジェクトは、宣言的設定ではなく、API を介して変更できます。これらは他のすべてのオブジェクトを参照することができます。DECLARATIVE_ORPHANED オリジンを持つオブジェクトは、API または宣言型設定のいずれかを介して変更できません。DECLARATIVE_ORPHANED リソースは、宣言的な設定で再定義されると、DECLARATIVE が再び DECLARATIVE になる可能性があります。この元のオブジェクトでは、他のリソースが参照されていない直後にシステムからクリーンアップされます。それらは他のすべてのオブジェクトで参照できます。
| Enum 値 |
|---|
| 命令 |
| デフォルト |
| 宣言的 |
| DECLARATIVE_ORPHANED |
5.2.7.8. TraitsVisibility
EXPERIMENTAL. 可視性により、特定の API に対してオブジェクトを表示するかどうかを指定できます。
| Enum 値 |
|---|
| VISIBLE |
| HIDDEN |
5.2.7.9. V1GetAuthProvidersResponse
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| authProviders |
'%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}