获取身份验证提供程序 - AuthProviderService | API 参考 | Red Hat Advanced Cluster Security for Kubernetes 4.6

GET /v1/authProviders

描述 (Description)

参数 (Parameters)

查询参数 (Query Parameters)

名称 (Name)	描述 (Description)	必填 (Required)	默认值 (Default)	模式 (Pattern)
名称 (name)		-	空 (null)
类型 (type)		-	空 (null)

名称 (Name)

描述 (Description)

必填 (Required)

默认值 (Default)

模式 (Pattern)

名称 (name)

空 (null)

类型 (type)

空 (null)

返回类型 (Return Type)

V1GetAuthProvidersResponse

内容类型 (Content Type)

application/json

响应 (Responses)

表 1. HTTP 响应代码 (Table 1. HTTP Response Codes)
代码 (Code)	消息 (Message)	数据类型 (Datatype)
200	成功的响应。(A successful response.)	V1GetAuthProvidersResponse
0	意外的错误响应。(An unexpected error response.)	GooglerpcStatus

示例 (Samples)

常用对象引用 (Common object reference)

AuthProviderRequiredAttribute

RequiredAttribute 允许指定一组属性，所有这些属性都必须由身份验证提供程序返回。如果中心颁发的令牌的外部声明中缺少任何属性，则对该 IdP 的身份验证请求将被视为失败。(RequiredAttribute allows to specify a set of attributes which ALL are required to be returned by the auth provider. If any attribute is missing within the external claims of the token issued by Central, the authentication request to this IdP is considered failed.)

字段名称 (Field Name)

必填 (Required)

可空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

属性键 (attributeKey)

字符串 (String)

属性值 (attributeValue)

字符串 (String)

GooglerpcStatus

字段名称 (Field Name)

必填 (Required)

可空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

代码 (code)

整数 (Integer)

int32

消息 (message)

字符串 (String)

详细信息 (details)

ProtobufAny 列表 (List of ProtobufAny)

ProtobufAny

Any 包含任意序列化的协议缓冲区消息以及描述序列化消息类型的 URL。(Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.)

Protobuf 库提供支持，以便以实用程序函数或 Any 类型的附加生成方法的形式打包/解包 Any 值。(Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.)

示例 1：在 C++ 中打包和解包消息。(Example 1: Pack and unpack a message in C++.)

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

示例 2：在 Java 中打包和解包消息。(Example 2: Pack and unpack a message in Java.)

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

protobuf 库提供的打包方法默认使用 'type.googleapis.com/full.type.name' 作为类型 URL，解包方法只使用类型 URL 中最后一个 '/' 后面的完全限定类型名称，例如 "foo.bar.com/x/y.z" 将产生类型名称 "y.z"。

JSON 表示

Any 值的 JSON 表示使用反序列化的嵌入式消息的常规表示，并添加一个包含类型 URL 的额外字段 @type。示例

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

如果嵌入式消息类型是众所周知的并且具有自定义 JSON 表示，则该表示将被嵌入，并添加一个包含自定义 JSON 的字段 value，以及 @type 字段。示例（对于消息 [google.protobuf.Duration][]）

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

字段名称 (Field Name) 必填 (Required) 可空 (Nullable) 类型 (Type) 描述 (Description) 格式 (Format)

字段名称 (Field Name)	必填 (Required)	可空 (Nullable)	类型 (Type)	描述 (Description)	格式 (Format)
@type			字符串 (String)	一个唯一标识序列化协议缓冲区消息类型的 URL/资源名称。此字符串必须包含至少一个“/”字符。URL 路径的最后一部分必须表示类型的完全限定名称（如 `path/google.protobuf.Duration`）。名称应采用规范形式（例如，不接受前导“.”）。实际上，团队通常会将其预期在 Any 上下文中使用的所有类型预编译到二进制文件中。但是，对于使用方案 `http`、`https` 或无方案的 URL，可以选择设置一个类型服务器，该服务器将类型 URL 映射到消息定义，如下所示：* 如果没有提供方案，则假定为 `https`。* 对 URL 的 HTTP GET 必须产生二进制格式的 [google.protobuf.Type][] 值，或者产生错误。* 应用程序可以根据 URL 缓存查找结果，或者将其预编译到二进制文件中以避免任何查找。因此，需要在类型更改时保留二进制兼容性。（使用版本化的类型名称来管理重大更改。）注意：此功能当前在官方 protobuf 版本中不可用，并且不用于以 type.googleapis.com 开头的类型 URL。截至 2023 年 5 月，没有广泛使用的类型服务器实现，也没有计划实现一个。可能使用除 `http`、`https`（或空方案）以外的其他方案，并具有特定于实现的语义。

@type

字符串 (String)

一个唯一标识序列化协议缓冲区消息类型的 URL/资源名称。此字符串必须包含至少一个“/”字符。URL 路径的最后一部分必须表示类型的完全限定名称（如 path/google.protobuf.Duration）。名称应采用规范形式（例如，不接受前导“.”）。实际上，团队通常会将其预期在 Any 上下文中使用的所有类型预编译到二进制文件中。但是，对于使用方案 http、https 或无方案的 URL，可以选择设置一个类型服务器，该服务器将类型 URL 映射到消息定义，如下所示：* 如果没有提供方案，则假定为 https。* 对 URL 的 HTTP GET 必须产生二进制格式的 [google.protobuf.Type][] 值，或者产生错误。* 应用程序可以根据 URL 缓存查找结果，或者将其预编译到二进制文件中以避免任何查找。因此，需要在类型更改时保留二进制兼容性。（使用版本化的类型名称来管理重大更改。）注意：此功能当前在官方 protobuf 版本中不可用，并且不用于以 type.googleapis.com 开头的类型 URL。截至 2023 年 5 月，没有广泛使用的类型服务器实现，也没有计划实现一个。可能使用除 http、https（或空方案）以外的其他方案，并具有特定于实现的语义。

StorageAuthProvider

下一个标签：15。

字段名称 (Field Name) 必填 (Required) 可空 (Nullable) 类型 (Type) 描述 (Description) 格式 (Format)

字符串 (String)

名称 (name)

字符串 (String)

类型 (type)

字符串 (String)

uiEndpoint

字符串 (String)

enabled

布尔值

config

string 的映射

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 回调模式，从“fragment”、“post”或“query”中选择。- “disable_offline_access_scope”：如果不需要颁发脱机令牌，则设置为“true”。- “extra_scopes”：根据 https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 请求的额外范围的空格分隔字符串，除了“openid profile 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)

validated

布尔值

extraUiEndpoints

string 的列表

除了ui_endpoint 之外还允许的 UI 端点。即，如果登录请求来自这些端点中的任何一个，则身份验证请求将对回调 URL 使用这些端点，而不是 ui_endpoint。

active

布尔值

requiredAttributes

AuthProviderRequiredAttribute 的列表

traits

StorageTraits

claimMappings

string 的映射

指定将从 IdP 令牌复制到 Rox 令牌属性的声明。此映射中的每个键都包含我们要映射的 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”则不是。我们支持以下类型的声明：* 字符串（路径“a.b”）* 布尔值（路径“a.d”）* 字符串数组（路径“a.e”）* 布尔数组（路径“a.f.”）我们不支持以下类型的声明：* 复杂声明（路径“a”）* 浮点/整数声明（路径“a.g”）* 浮点/整数数组声明（路径“a.h”）此映射中的每个值都包含我们要向其添加声明的 Rox 令牌属性名称。例如，如果值为“groups”，则声明将位于令牌中的“external_user.Attributes.groups”中。注意：我们仅支持 OIDC 身份验证提供程序的此功能。

lastUpdated

日期

上次更新指示身份验证提供程序上次更新的时间。如果在该时间戳之前已由身份验证提供程序颁发令牌，则这些令牌将被视为无效。随后，所有客户端都必须重新颁发其令牌（通过刷新或额外的登录尝试）。

日期时间

StorageTraits

字段名称 (Field Name)	类型 (Type)	格式 (Format)
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE，ALLOW_MUTATE_FORCED，
visibility	TraitsVisibility	VISIBLE，HIDDEN，
origin	TraitsOrigin	IMPERATIVE，DEFAULT，DECLARATIVE，DECLARATIVE_ORPHANED，

字段名称 (Field Name)

必填 (Required)

可空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

mutabilityMode

TraitsMutabilityMode

ALLOW_MUTATE，ALLOW_MUTATE_FORCED，

visibility

TraitsVisibility

VISIBLE，HIDDEN，

origin

TraitsOrigin

IMPERATIVE，DEFAULT，DECLARATIVE，DECLARATIVE_ORPHANED，

TraitsMutabilityMode

实验性。注意：请暂时避免使用 MutabilityMode。它将在将来被替换（ROX-14276）。MutabilityMode 指定对象是否以及如何修改。默认为 ALLOW_MUTATE，表示没有修改限制；这等效于没有 MutabilityMode 规范。ALLOW_MUTATE_FORCED 禁止所有修改操作，除了强制位打开的对象删除。

更改此字段的状态时请小心。例如，将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED 是允许的，但这将禁止对其进行任何进一步的更改，包括将其修改回 ALLOW_MUTATE。

枚举值
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

枚举值

ALLOW_MUTATE

ALLOW_MUTATE_FORCED

TraitsOrigin

Origin 指定对象的来源。对象可以有四种不同的来源：- IMPERATIVE：对象是通过 API 创建的。这是默认假设。- DEFAULT：对象是默认对象，例如默认角色、访问范围等。- DECLARATIVE：对象是通过声明性配置创建的。- DECLARATIVE_ORPHANED：对象是通过声明性配置创建的，然后未成功删除（例如，因为它被另一个对象引用）。根据来源，不同的规则适用于对象。不允许通过 API 修改具有 DECLARATIVE 来源的对象，只能通过声明性配置修改。此外，它们可能不会引用具有 IMPERATIVE 来源的对象。不允许通过 API 或声明性配置修改具有 DEFAULT 来源的对象。它们可以被所有其他对象引用。允许通过 API 修改具有 IMPERATIVE 来源的对象，但不能通过声明性配置修改。它们可以引用所有其他对象。不允许通过 API 或声明性配置修改具有 DECLARATIVE_ORPHANED 来源的对象。如果在声明性配置中重新定义，DECLARATIVE_ORPHANED 资源可以再次成为 DECLARATIVE。不再被其他资源引用后，具有此来源的对象将立即从系统中清理。它们可以被所有其他对象引用。

枚举值
IMPERATIVE
DEFAULT
DECLARATIVE
声明式孤儿

枚举值

IMPERATIVE

DEFAULT

DECLARATIVE

声明式孤儿

TraitsVisibility

实验性功能。visibility 属性指定对象是否对某些API可见。

枚举值
可见
隐藏

枚举值

可见

隐藏

V1GetAuthProvidersResponse

字段名称 (Field Name)

必填 (Required)

可空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

authProviders

StorageAuthProvider 列表