第 6 章 AuthService


6.1. UpdateAuthMachineToMachineConfig

PUT /v1/auth/m2m/{config.id}

UpdateAuthMachineToMachineConfig 将现有的 auth 机器更新为机器配置。如果 auth 机器到机器配置不存在,则会创建一个新机器。

6.1.1. 描述

6.1.2. 参数

6.1.2.1. 路径参数

Expand
Name描述必填defaultpattern

config.id

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

X

null

 

6.1.2.2. 正文参数

Expand
Name描述必填defaultpattern

正文(body)

V1UpdateAuthMachineToMachineConfigRequest

X

  

6.1.3. 返回类型

对象

6.1.4. 内容类型

  • application/json

6.1.5. 响应

Expand
表 6.1. HTTP 响应代码
代码消息datatype

200

成功响应。

对象

0

意外错误响应。

RuntimeError

6.1.6. Samples

6.1.7. 常规对象参考

6.1.7.1. AuthMachineToMachineConfigMapping

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

Expand
字段名称必填nullable类型描述格式

key

  

字符串

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

 

valueExpression

  

字符串

一个正则表达式,它将针对指定键标识的身份令牌声明的值进行评估。这个正则表达式采用 RE2 格式,更多详情: https://github.com/google/re2/wiki/Syntax

 

role

  

字符串

当一个特定身份令牌的键和值匹配时,应发出的角色。

 

6.1.7.2. ProtobufAny

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

protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。

示例 1: Pack 并在 C++ 中解包信息。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}
Copy to Clipboard Toggle word wrap

示例 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());
}
Copy to Clipboard Toggle word wrap
Example 3: Pack and unpack a message in Python.
Copy to Clipboard Toggle word wrap
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
Copy to Clipboard Toggle word wrap
Example 4: Pack and unpack a message in Go
Copy to Clipboard Toggle word wrap
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}
Copy to Clipboard Toggle word wrap

默认情况下,protobuf 库提供的软件包方法将使用 'type.googleapis.com/full.type.name' 作为类型 URL,解包方法只使用类型 URL 中的完全限定类型名称,如 "foo.bar.com/x/x/y.z"。

6.1.7.2.1. JSON 表示

any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @typeExample:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}
Copy to Clipboard Toggle word wrap

如果嵌入式消息类型是知名且具有自定义 JSON 表示法,则该表示将被嵌入一个字段值,该值@type 字段外还包含自定义 JSON。示例(用于消息 [google.protobuf.Duration][]):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Copy to Clipboard Toggle word wrap
Expand
字段名称必填nullable类型描述格式

typeUrl

  

字符串

唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 path/google.protobuf.Duration)。名称应采用规范形式(例如,未接受前面的 \".\")。在实践中,团队通常会预编译到期望其在任意上下文中使用的所有类型的二进制代码。但是,对于使用方案 httphttps 或无方案的 URL,可以选择设置一个类型服务器,将类型 URL 映射到消息定义,如下所示:* 如果没有提供方案,则假设 https。* URL 上的 HTTP GET 必须以二进制格式生成一个 [google.protobuf.Type][] 值,或者产生错误。* 应用程序允许根据 URL 缓存查找结果,或者预先编译到二进制文件以避免出现任何查找。因此,为了更改类型,二进制兼容性需要保留。(使用版本控制类型名称来管理中断的更改。)注意:这个功能目前在官方 protobuf 版本中可用,它不用于以 type.googleapis.com 开头的类型 URL。自 2023 年 5 月起,没有广泛使用的类型服务器实施,没有计划实施。http 之外的方案(或空方案)可以与实施特定语义一起使用。

 

value

  

byte[]

必须是上述指定类型的有效序列化协议缓冲。

BYTE

6.1.7.3. RuntimeError

Expand
字段名称必填nullable类型描述格式

错误

  

字符串

  

code

  

整数

 

int32

message

  

字符串

  

详情

  

ProtobufAny列表

  

6.1.7.4. V1AuthMachineToMachineConfig

AuthMachineToMachineConfig 决定从带有 Central 访问令牌的第三方交换身份令牌的规则。M2M 代表机器,因为这是配置的预期用例。

Expand
字段名称必填nullable类型描述格式

id

  

字符串

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

 

type

  

V1AuthMachineToMachineConfigType

 

GENERIC, GITHUB_ACTIONS,

tokenExpirationDuration

  

字符串

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

 

映射

  

AuthMachineToMachineConfigMapping列表

至少需要一个映射才能成功生成访问令牌的有效角色。

 

Issuer

  

字符串

相关 OIDC 供应商发布 ID 令牌来交换的签发者。当类型为 GENERIC 时,必须是包含 URL 的非空字符串。如果是 GitHub 操作,则必须为空,或设置为 https://token.actions.githubusercontent.com。issuer 是一个唯一的密钥,因此最多可能有一个 GITHUB_ACTIONS 配置,每个 GENERIC 配置必须具有不同的签发者。

 

6.1.7.5. V1AuthMachineToMachineConfigType

机器配置的 auth 机器的类型。目前支持 GitHub 操作或其他通用 OIDC 供应商来验证和交换令牌。

Expand
Enum 值

GENERIC

GITHUB_ACTIONS

6.1.7.6. V1UpdateAuthMachineToMachineConfigRequest

Expand
字段名称必填nullable类型描述格式

config

  

V1AuthMachineToMachineConfig

  
返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat