Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

第6章 AuthService

6.1. UpdateAuthMachineToMachineConfig
リンクのコピー

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

UpdateAuthMachineToMachineConfig は、既存の認証マシンをマシン設定に更新します。マシン設定への auth マシンが存在しない場合は、新しいマシン設定が作成されます。

6.1.1. 説明
リンクのコピー

6.1.2. パラメーター
リンクのコピー

6.1.2.1. パスパラメーター
リンクのコピー

Expand
名前説明必須デフォルトPattern

config.id

設定の UUID。マシン設定に追加する際に、このフィールドは設定できないことに注意してください。

X

null

 

6.1.2.2. ボディパラメーター
リンクのコピー

Expand
名前説明必須デフォルトPattern

body

V1UpdateAuthMachineToMachineConfigRequest

X

  

6.1.3. 戻り値のタイプ
リンクのコピー

Object

6.1.4. コンテンツタイプ
リンクのコピー

  • application/json

6.1.5. レスポンス
リンクのコピー

Expand
表6.1 HTTP 応答コード
コードメッセージデータタイプ

200

正常な応答。

Object

0

予期しないエラーの応答です。

RuntimeError

6.1.6. サンプル
リンクのコピー

6.1.7. 共通のオブジェクト参照
リンクのコピー

6.1.7.1. AuthMachineToMachineConfigMapping
リンクのコピー

マッピングにより、アイデンティティートークンのクレーム値が Central 内の特定のロールにマッピングされます。

Expand
フィールド名必須Null 許容型型説明形式

key

  

String

使用する ID トークンのクレーム値内のキー。

 

valueExpression

  

String

指定されたキーで識別されるアイデンティティートークンクレームの値に対して評価される正規表現。この正規表現は RE2 形式になります。https://github.com/google/re2/wiki/Syntax を参照してください。

 

role

  

String

キーと値が特定の ID トークンと一致するときに発行する必要があるロール。

 

6.1.7.2. ProtobufAny
リンクのコピー

any には、シリアライズされたメッセージの型を記述する URL とともに、任意のシリアライズされたプロトコルバッファーメッセージが含まれます。

Protobuf ライブラリーは、パック/アンパックをサポートします。任意の値は、ユーティリティー関数の形式で、または Any タイプの追加の生成されたメソッドになります。

例 1: 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 として使用し、unzip メソッドは、タイプ URL の最後の//のみを使用します。たとえば、"foo.bar.com/x/y.z" のように、"foo.bar.com/x/y.z" の型名 "y.z" が生成されます。

6.1.7.2.1. JSON 表現
リンクのコピー

Any 値の JSON 表現は、デシリアライズされた埋め込みメッセージの通常の表現を使用し、タイプ URL が含まれる追加のフィールド @type を使用します。以下に例を示します。 

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
フィールド名必須Null 許容型型説明形式

typeUrl

  

String

シリアライズされたプロトコルバッファーメッセージのタイプを一意に識別する URL/リソース名。この文字列には最低でも 1 つの \"/\" 文字を含める必要があります。URL のパスの最後のセグメントは、タイプの完全修飾名( path/google.protobuf.Durationにあるように)を表す必要があります。名前は正規の形式である必要があります（たとえば、先頭 \".\" は受け入れられません）。実際には、チームは通常、バイナリーにプリコンパイルして、任意 のコンテキストで使用することを期待しているすべてのタイプにプレコンパイルします。ただし、スキーム http、https、またはスキームを使用しない URL の場合、以下のようにタイプ URL をメッセージ定義にマップするタイプサーバーを設定できます。* スキームが指定されていない場合、https は想定されます。* URL の HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成するか、エラーを生成する必要があります。* アプリケーションは、URL に基づいてルックアップ結果をキャッシュするか、ルックアップを回避するためにバイナリーにプリコンパイルして使用できます。したがって、タイプへの変更時にバイナリー互換性を保持する必要があります。（バージョン付けされたタイプ名を使用して、重大な変更を管理します。）注記：この機能は現在、公式の protobuf リリースでは利用できないため、type.googleapis.com で始まるタイプ URL には使用されません。2023 年 5 月時点では、広く使用されているタイプサーバー実装はもう 1 つも実装する予定はありません。http 以外のスキーム、https （または空のスキーム）は、実装固有のセマンティクスで使用できます。

 

value

  

byte[]

上記の指定されたタイプの有効なシリアライズされたプロトコルバッファーである必要があります。

byte

6.1.7.3. RuntimeError
リンクのコピー

Expand
フィールド名必須Null 許容型型説明形式

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

ProtobufAnyのリスト

  

6.1.7.4. V1AuthMachineToMachineConfig
リンクのコピー

AuthMachineToMachineConfig は、Central アクセストークンを使用して、サードパーティーから ID トークンを交換するためのルールを決定します。M2M は、設定の意図されたユースケースであるため、マシンへのマシンを表します。

Expand
フィールド名必須Null 許容型型説明形式

id

  

String

設定の UUID。マシン設定に追加する際に、このフィールドは設定できないことに注意してください。

 

type

  

V1AuthMachineToMachineConfigType

 

GENERIC, GITHUB_ACTIONS,

tokenExpirationDuration

  

String

ExchangeAuthMachineToMachineToken API 呼び出しから返されるトークンの有効期限を設定します。有効な時間単位は、s、m、h です。最大許容有効期限は 24h です。たとえば、2h45m です。期間の検証に関する追加情報は、https://pkg.go.dev/time#ParseDuration を参照してください。

 

マッピング

  

List of AuthMachineToMachineConfigMapping

アクセストークンを正常に生成するには、有効なロールに対して解決するには、1 つ以上のマッピングが必要です。

 

issuer

  

String

交換する ID トークンを発行する、関連する OIDC プロバイダーの発行者。タイプが GENERIC の場合は、URL が含まれる空でない文字列である必要があります。GitHub アクションの場合、これは空であるか、https://token.actions.githubusercontent.com に設定する必要があります。発行者は一意のキーであるため、最大 1 つの GITHUB_ACTIONS 設定があり、各 GENERIC 設定には個別の発行者が必要です。

 

6.1.7.5. V1AuthMachineToMachineConfigType
リンクのコピー

マシン設定への認証マシンのタイプ。現在、トークンの検証および交換に使用する GitHub アクションまたはその他の汎用 OIDC プロバイダーをサポートしています。

Expand
Enum 値

GENERIC

GITHUB_ACTIONS

6.1.7.6. V1UpdateAuthMachineToMachineConfigRequest
リンクのコピー

Expand
フィールド名必須Null 許容型型説明形式

config

  

V1AuthMachineToMachineConfig

  
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat