REST Resource: projects.locations.backendAuthenticationConfigs

Resource: BackendAuthenticationConfig

BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend:

  • trustConfig is the attached TrustConfig.

  • wellKnownRoots indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig.

  • clientCertificate is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS.

You can attach the BackendAuthenticationConfig to the load balancer’s BackendService directly determining how that BackendService negotiates TLS.

JSON representation 
{
  "name": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "clientCertificate": string,
  "trustConfig": string,
  "wellKnownRoots": enum (WellKnownRoots),
  "etag": string
}
Fields
name

string

Required. Name of the BackendAuthenticationConfig resource. It matches the pattern projects/*/locations/{location}/backendAuthenticationConfigs/{backendAuthenticationConfig}
description

string

Optional. Free-text description of the resource.
createTime

string (Timestamp format)

Output only. The timestamp when the resource was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The timestamp when the resource was updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Set of label tags associated with the resource.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
clientCertificate

string

Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}".

Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope.
trustConfig

string

Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trustConfig}".

A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS.
wellKnownRoots

enum (WellKnownRoots)

Well known roots to use for server certificate validation.
etag

string

Output only. Etag of the resource.

WellKnownRoots

Enum to specify the well known roots to use for server certificate validation.

Enums
WELL_KNOWN_ROOTS_UNSPECIFIED Equivalent to NONE.
NONE The BackendService will only validate server certificates against roots specified in TrustConfig.
PUBLIC_ROOTS

The BackendService uses a set of well-known public roots, in addition to any roots specified in the trustConfig field, when validating the server certificates presented by the backend. Validation with these roots is only considered when the TlsSettings.sni field in the BackendService is set.

The well-known roots are a set of root CAs managed by Google. CAs in this set can be added or removed without notice.

Methods

create

 Creates a new BackendAuthenticationConfig in a given project and location.

delete

 Deletes a single BackendAuthenticationConfig to BackendAuthenticationConfig.

get

 Gets details of a single BackendAuthenticationConfig to BackendAuthenticationConfig.

list

 Lists BackendAuthenticationConfigs in a given project and location.

patch

 Updates the parameters of a single BackendAuthenticationConfig to BackendAuthenticationConfig.