ApiAuthentication

API 调用所需的身份验证信息。

JSON 表示法 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "apiKeyConfig": {
    object (ApiKeyConfig)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "serviceAgentIdTokenAuthConfig": {
    object (ServiceAgentIdTokenAuthConfig)
  },
  "serviceAccountAuthConfig": {
    object (ServiceAccountAuthConfig)
  },
  "bearerTokenConfig": {
    object (BearerTokenConfig)
  }
  // End of mutually exclusive fields.
}
字段
身份验证配置。以下是互斥字段的列表。在响应中，最多只能设置以下字段之一：
apiKeyConfig

object (ApiKeyConfig)

可选。API 密钥身份验证的配置。
oauthConfig

object (OAuthConfig)

可选。OAuth 的配置。
serviceAgentIdTokenAuthConfig

object (ServiceAgentIdTokenAuthConfig)

可选。从 CES 服务代理生成的 ID 令牌身份验证配置。
serviceAccountAuthConfig

object (ServiceAccountAuthConfig)

可选。服务账号身份验证的配置。
bearerTokenConfig

object (BearerTokenConfig)

可选。不记名令牌身份验证的配置。
互斥字段的结束。

ApiKeyConfig

使用 API 密钥进行身份验证的配置。

JSON 表示法 
{
  "keyName": string,
  "apiKeySecretVersion": string,
  "requestLocation": enum (ApiKeyConfig.RequestLocation)
}
字段
keyName

string

必需。API 密钥的参数名称或标头名称。例如，如果 API 请求为“https://example.com/act?X-Api-Key="，则“X-Api-Key”为参数名称。
apiKeySecretVersion

string

必需。存储 API 密钥的 SecretManager Secret 版本资源的名称。格式：projects/{project}/secrets/{secret}/versions/{version}

注意：您应向 CES 服务代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com 授予 roles/secretmanager.secretAccessor 角色。
requestLocation

enum (ApiKeyConfig.RequestLocation)

必需。请求中的密钥位置。

ApiKeyConfig.RequestLocation

请求中 API 密钥的位置。

枚举
REQUEST_LOCATION_UNSPECIFIED 未指定。不应使用此值。
HEADER 表示 HTTP 标头中的键。
QUERY_STRING 表示查询字符串中的键。

OAuthConfig

使用 OAuth 进行身份验证的配置。

JSON 表示法 
{
  "oauthGrantType": enum (OAuthConfig.OauthGrantType),
  "clientId": string,
  "clientSecretVersion": string,
  "tokenEndpoint": string,
  "scopes": [
    string
  ]
}
字段
oauthGrantType

enum (OAuthConfig.OauthGrantType)

必需。OAuth 授权类型。
clientId

string

必需。OAuth 提供方的客户端 ID。
clientSecretVersion

string

必需。存储客户端密钥的 SecretManager 密钥版本资源的名称。格式：projects/{project}/secrets/{secret}/versions/{version}

注意：您应向 CES 服务代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com 授予 roles/secretmanager.secretAccessor 角色。
tokenEndpoint

string

必需。OAuth 提供方中用于换取访问令牌的令牌端点。
scopes[]

string

可选。要授予的 OAuth 范围。

OAuthConfig.OauthGrantType

OAuth 授权类型。仅支持客户端凭据授权。

枚举
OAUTH_GRANT_TYPE_UNSPECIFIED 未指定。默认值为 CLIENT_CREDENTIAL。
CLIENT_CREDENTIAL 表示客户端凭证流程。

ServiceAgentIdTokenAuthConfig

此类型没有字段。

使用从服务代理生成的 ID 令牌进行身份验证的配置。

ServiceAccountAuthConfig

使用自定义服务账号进行身份验证的配置。

JSON 表示法 
{
  "serviceAccount": string,
  "scopes": [
    string
  ]
}
字段
serviceAccount

string

必需。用于身份验证的服务账号的电子邮件地址。CES 使用此服务账号来交换访问令牌，然后将该访问令牌发送到请求的 Authorization 标头中。

服务账号必须具有授予 CES 服务代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com 的 roles/iam.serviceAccountTokenCreator 角色。
scopes[]

string

可选。要授予的 OAuth 范围。如果未指定，则使用默认范围 https://www.googleapis.com/auth/cloud-platform。

BearerTokenConfig

使用不记名令牌进行身份验证的配置。

JSON 表示法 
{
  "token": string
}
字段
token

string

必需。不记名令牌。必须采用 $context.variables.<name_of_variable> 格式。