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

6.7. GetAuthStatus

GET /v1/auth/status

GetAuthStatus は、現在のクライアントのステータスを返します。

6.7.1. 説明
リンクのコピー

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

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

V1AuthStatus

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

  • application/json

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

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

200

正常な応答。

V1AuthStatus

0

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

RuntimeError

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

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

6.7.7.1. AuthProviderRequiredAttribute
リンクのコピー

RequiredAttribute を使用すると、認証プロバイダーによって返される必要がある属性のセットを指定できます。Central が発行するトークンの外部要求内に属性がない場合、この IdP への認証要求は失敗とみなされます。

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

attributeKey

  

String

  

attributeValue

  

String

  

6.7.7.2. ProtobufAny
リンクのコピー

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

Protobuf ライブラリーは、パック/アンパックをサポートします。任意の値は、ユーティリティー関数の形式で、または 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 ライブラリーが提供するパックメソッドは、デフォルトで type.googleapis.com/full.type.name をタイプ URL として使用し、unzip メソッドは、タイプ URL の最後の//のみを使用します。たとえば、"foo.bar.com/x/y.z" のように、"foo.bar.com/x/y.z" の型名 "y.z" が生成されます。

6.7.7.2.1. 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 表現がある場合、その表現は埋め込みされ、@type フィールドに加えてカスタム JSON を保持するフィールド 値 が追加されます。例（メッセージ [google.protobuf.Duration][] の場合）: 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
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.7.7.3. RuntimeError
リンクのコピー

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

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

ProtobufAnyのリスト

  

6.7.7.4. StorageAccess
リンクのコピー

Expand
Enum 値

NO_ACCESS

READ_ACCESS

READ_WRITE_ACCESS

6.7.7.5. StorageAuthProvider
リンクのコピー

次のタグ：15

Expand
フィールド名必須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

  

string のリスト

ui_endpoint に加えて許可する UI エンドポイント。つまり、ログインリクエストがこれらのいずれかから送信される場合、認証リクエストはこれらをコールバック URL に使用します(ui_endpoint ではなく)。

 

active

  

Boolean

  

requiredAttributes

  

AuthProviderRequiredAttributeのリスト

  

traits

  

StorageTraits

  

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

6.7.7.6. StorageServiceIdentity
リンクのコピー

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

serialStr

  

String

  

serial

  

String

 

int64

id

  

String

  

type

  

StorageServiceType

 

UNKNOWN_SERVICE、SENSOR_SERVICE、CENTRAL_SERVICE、CENTRAL_DB_SERVICE、REMOTE_SERVICE、COLLECTOR_SERVICE、MONITORING_UI_SERVICE、MONITORING_DB_SERVICE、MONITORING_CLIENT_SERVICE、ASNCHMARK_SERVICE、SCANNER_SERVICE、SCANNER_DB_SERVICE、ADMISSION_CONTROL_SERVICE、SCANNER_V4_INDEXER_SERVICE、SCANNER_V4_MATCHER_SERVICE、SCANNER_V4_DB_SERVICE、

initBundleId

  

String

  

6.7.7.7. StorageServiceType
リンクのコピー

Next available tag: 16
Expand
Enum 値

UNKNOWN_SERVICE

SENSOR_SERVICE

CENTRAL_SERVICE

CENTRAL_DB_SERVICE

REMOTE_SERVICE

COLLECTOR_SERVICE

MONITORING_UI_SERVICE

MONITORING_DB_SERVICE

MONITORING_CLIENT_SERVICE

BENCHMARK_SERVICE

SCANNER_SERVICE

SCANNER_DB_SERVICE

ADMISSION_CONTROL_SERVICE

SCANNER_V4_INDEXER_SERVICE

SCANNER_V4_MATCHER_SERVICE

SCANNER_V4_DB_SERVICE

6.7.7.8. StorageTraits
リンクのコピー

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

mutabilityMode

  

TraitsMutabilityMode

 

ALLOW_MUTATE, ALLOW_MUTATE_FORCED,

visibility

  

TraitsVisibility

 

VISIBLE、HIDDEN、

origin

  

TraitsOrigin

 

命令、デフォルト、宣言的、DECLARATIVE_ORPHANED

6.7.7.9. StorageUserInfo
リンクのコピー

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

username

  

String

  

friendlyName

  

String

  

permissions

  

UserInfoResourceToAccess

  

roles

  

StorageUserInfoRoleのリスト

  

6.7.7.10. StorageUserInfoRole
リンクのコピー

ロールは、古い storage.Role 形式との互換性があるため、ロール名と関連するパーミッションのみが含まれます。

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

name

  

String

  

resourceToAccess

  

StorageAccessのマップ

  

6.7.7.11. TraitsMutabilityMode
リンクのコピー

実験的注記：当面は、MutabilityMode の使用を参照してください。これは今後置き換えられる予定です(ROX-14276)。MutabilityMode は、オブジェクトを変更するかどうか、およびその方法を指定します。デフォルトは ALLOW_MUTATE であり、変更制限がないことを意味します。これは、MutabilityMode 仕様がないことと同等です。ALLOW_MUTATE_FORCED は、force ビットでのオブジェクト削除以外のすべての変更操作を禁止します。

このフィールドの状態を変更するときは注意してください。たとえば、オブジェクトを ALLOW_MUTATE から ALLOW_MUTATE_FORCED に変更することは許可されますが、これを変更すると、ALLOW_MUTATE に戻すなど、それ以降の変更はできなくなります。

Expand
Enum 値

ALLOW_MUTATE

ALLOW_MUTATE_FORCED

6.7.7.12. TraitsOrigin
リンクのコピー

origin は、オブジェクトの発信元を指定します。オブジェクトには、発信元を 4 つ持つことができます：- IMPERATIVE: オブジェクトは API 経由で作成されました。これはデフォルトで仮定されます。- DEFAULT: オブジェクトは、デフォルトのロール、アクセススコープなどのデフォルトオブジェクトです。DECLARATIVE: オブジェクトは宣言型設定を使用して作成されます。- DECLARATIVE_ORPHANED: オブジェクトは宣言型設定によって作成され、（たとえば、別のオブジェクトで参照されるため）作成元に基づいて別のルールがオブジェクトに適用されます。DECLARATIVE オリジンを持つオブジェクトは、宣言的設定を介してのみ API 経由で変更することはできません。さらに、IMPERATIVE オリジンを使用してオブジェクトを参照することはできません。DEFAULT オリジンを持つオブジェクトは、API または宣言型設定のいずれかを介して変更することはできません。それらは他のすべてのオブジェクトで参照できます。IMPERATIVE オリジンを持つオブジェクトは、宣言的設定ではなく、API を介して変更できます。これらは他のすべてのオブジェクトを参照することができます。DECLARATIVE_ORPHANED オリジンを持つオブジェクトは、API または宣言型設定のいずれかを介して変更できません。DECLARATIVE_ORPHANED リソースは、宣言的な設定で再定義されると、DECLARATIVE が再び DECLARATIVE になる可能性があります。この元のオブジェクトでは、他のリソースが参照されていない直後にシステムからクリーンアップされます。それらは他のすべてのオブジェクトで参照できます。

Expand
Enum 値

命令

デフォルト

宣言的

DECLARATIVE_ORPHANED

6.7.7.13. TraitsVisibility
リンクのコピー

EXPERIMENTAL. 可視性により、特定の API に対してオブジェクトを表示するかどうかを指定できます。

Expand
Enum 値

VISIBLE

HIDDEN

6.7.7.14. UserInfoResourceToAccess
リンクのコピー

ResourceToAccess は、パーミッションのコレクションを表します。これは、古い storage.Role 形式との互換性があり、集約されたパーミッションのみが必要な場所に置き換えます。

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

resourceToAccess

  

StorageAccessのマップ

  

6.7.7.15. V1AuthStatus
リンクのコピー

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

userId

  

String

  

serviceId

  

StorageServiceIdentity

  

Expires

  

Date

 

date-time

refreshUrl

  

String

  

authProvider

  

StorageAuthProvider

  

userInfo

  

StorageUserInfo

  

userAttributes

  

V1UserAttributeのリスト

  

idpToken

  

String

基礎となる ID プロバイダーによって ACS に返されるトークン。このフィールドは、いくつかの特定のコンテキストでのみ設定されます。応答に存在するこのフィールドに依存しないでください。

 

6.7.7.16. V1UserAttribute
リンクのコピー

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

key

  

String

  

values

  

string のリスト

  
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2026 Red Hatトップに戻る