ListAuthMachineToMachineConfigs - AuthService | API 参考 | Red Hat 高级集群安全 for Kubernetes 4.6

GET /v1/auth/m2m

ListAuthMachineToMachineConfigs 列出可用的身份验证机器到机器配置。

描述

参数

返回类型

V1ListAuthMachineToMachineConfigResponse

内容类型

application/json

响应

表1. HTTP响应代码
代码	消息	数据类型
200	成功的响应。	V1ListAuthMachineToMachineConfigResponse
0	意外的错误响应。	GooglerpcStatus

示例

常用对象引用

AuthMachineToMachineConfigMapping

映射将身份令牌的声明值映射到Central中的特定角色。

字段名称	类型	描述
键	字符串	身份令牌声明值中要使用的键。
valueExpression	字符串	一个正则表达式，它将针对指定键标识的身份令牌声明的值进行评估。此正则表达式采用RE2格式，此处了解更多信息：https://github.com/google/re2/wiki/Syntax。
角色	字符串	当某个身份令牌的键和值匹配时，应颁发的角色。

字段名称

必填

可空

类型

描述

格式

键

字符串

身份令牌声明值中要使用的键。

valueExpression

字符串

一个正则表达式，它将针对指定键标识的身份令牌声明的值进行评估。此正则表达式采用RE2格式，此处了解更多信息：https://github.com/google/re2/wiki/Syntax。

角色

字符串

当某个身份令牌的键和值匹配时，应颁发的角色。

GooglerpcStatus

字段名称

必填

可空

类型

描述

格式

代码

整数

int32

消息

字符串

细节

ProtobufAny 列表

ProtobufAny

Any包含任意序列化的协议缓冲区消息以及描述序列化消息类型的URL。

Protobuf库提供支持，以实用程序函数或Any类型的其他生成方法的形式打包/解包Any值。

示例1：在C++中打包和解包消息。

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

示例2：在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库提供的pack方法默认使用'type.googleapis.com/full.type.name'作为类型URL，unpack方法只使用类型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表示，则该表示将被嵌入，添加一个字段value，该字段除了@type字段外还包含自定义JSON。示例（对于消息[google.protobuf.Duration][]）

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

字段名称必填可空类型描述格式

字段名称	必填	可空	类型	描述	格式
@type			字符串	一个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

字符串

一个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（或空方案）之外的方案可能会与特定于实现的语义一起使用。

V1AuthMachineToMachineConfig

AuthMachineToMachineConfig 确定了将第三方身份令牌与中心访问令牌交换的规则。M2M 代表机器对机器，因为这是此配置的预期用例。

字段名称	类型	描述	格式
id	字符串	配置的UUID。请注意，在添加机器到机器配置时，不应设置此字段。
type	V1AuthMachineToMachineConfigType		GENERIC, GITHUB_ACTIONS, KUBE_SERVICE_ACCOUNT,
tokenExpirationDuration	字符串	设置从ExchangeAuthMachineToMachineToken API 调用返回的令牌的过期时间。可能的有效时间单位：s、m、h。最大允许过期时间为24小时。例如：2h45m。有关持续时间验证的更多信息，请参见：https://pkg.go.dev/time#ParseDuration。
mappings	AuthMachineToMachineConfigMapping 列表	至少需要一个映射才能解析为有效的角色，以便成功生成访问令牌。
issuer	字符串	颁发相关 OIDC 提供商颁发的用于交换的 ID 令牌的颁发者。当类型为 GENERIC 时，必须是非空字符串，包含 URL。对于 GitHub Actions，此字段必须为空或设置为 https://token.actions.githubusercontent.com。颁发者是唯一的键，因此最多只能有一个 GITHUB_ACTIONS 配置，并且每个 GENERIC 配置必须具有不同的颁发者。

字段名称

必填

可空

类型

描述

格式

字符串

配置的UUID。请注意，在添加机器到机器配置时，不应设置此字段。

type

V1AuthMachineToMachineConfigType

GENERIC, GITHUB_ACTIONS, KUBE_SERVICE_ACCOUNT,

tokenExpirationDuration

字符串

设置从ExchangeAuthMachineToMachineToken API 调用返回的令牌的过期时间。可能的有效时间单位：s、m、h。最大允许过期时间为24小时。例如：2h45m。有关持续时间验证的更多信息，请参见：https://pkg.go.dev/time#ParseDuration。

mappings

AuthMachineToMachineConfigMapping 列表

至少需要一个映射才能解析为有效的角色，以便成功生成访问令牌。

issuer

字符串

颁发相关 OIDC 提供商颁发的用于交换的 ID 令牌的颁发者。当类型为 GENERIC 时，必须是非空字符串，包含 URL。对于 GitHub Actions，此字段必须为空或设置为 https://token.actions.githubusercontent.com。颁发者是唯一的键，因此最多只能有一个 GITHUB_ACTIONS 配置，并且每个 GENERIC 配置必须具有不同的颁发者。

V1AuthMachineToMachineConfigType

机器到机器配置的类型。目前支持 GitHub Actions 或任何其他通用的 OIDC 提供商来验证和交换令牌。

枚举值
GENERIC
GITHUB_ACTIONS
KUBE_SERVICE_ACCOUNT

枚举值

GENERIC

GITHUB_ACTIONS

KUBE_SERVICE_ACCOUNT

V1ListAuthMachineToMachineConfigResponse

字段名称

必填

可空

类型

描述

格式

configs

V1AuthMachineToMachineConfig 列表