GetLoginAuthProviders - AuthProviderService | API 参考 | Red Hat Advanced Cluster Security for Kubernetes 4.6

GET /v1/login/authproviders

描述(Description)

参数(Parameters)

返回类型(Return Type)

内容类型(Content Type)

application/json

响应(Responses)

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

示例(Samples)

常用对象引用(Common object reference)

GetLoginAuthProvidersResponseLoginAuthProvider

字段名(Field Name)

必填(Required)

可空(Nullable)

类型(Type)

描述(Description)

格式(Format)

字符串(String)

名称(name)

字符串(String)

类型(type)

字符串(String)

登录URL(loginUrl)

字符串(String)

GooglerpcStatus

字段名(Field Name)

必填(Required)

可空(Nullable)

类型(Type)

描述(Description)

格式(Format)

代码(code)

整数(Integer)

int32

消息(message)

字符串(String)

详情(details)

ProtobufAny 列表(ProtobufAny List)

ProtobufAny

Any包含任意序列化的protocol buffer消息以及描述序列化消息类型的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库提供的打包方法默认使用'type.googleapis.com/full.type.name'作为类型URL，解包方法仅使用类型URL中最后一个'/'后的完全限定类型名称，例如"foo.bar.com/x/y.z"将产生类型名称"y.z"。

JSON表示(JSON representation)

Any值的JSON表示使用反序列化的嵌入式消息的常规表示，以及包含类型URL的附加字段@type。示例(Example)

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][]）(Example (for message [google.protobuf.Duration][]))

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

字段名(Field Name)	必填(Required)	可空(Nullable)	类型(Type)	描述(Description)	格式(Format)
@type			字符串(String)	一个 URL/资源名称，用于唯一标识序列化 Protocol Buffer 消息的类型。此字符串必须包含至少一个“/”字符。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`（或空方案）以外的方案可能与实现特定的语义一起使用。

字段名(Field Name)

必填(Required)

可空(Nullable)

类型(Type)

描述(Description)

格式(Format)

@type

字符串(String)

一个 URL/资源名称，用于唯一标识序列化 Protocol Buffer 消息的类型。此字符串必须包含至少一个“/”字符。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`（或空方案）以外的方案可能与实现特定的语义一起使用。

V1GetLoginAuthProvidersResponse

字段名(Field Name)

必填(Required)

可空(Nullable)

类型(Type)

描述(Description)

格式(Format)

authProviders

GetLoginAuthProvidersResponseLoginAuthProvider 列表