org.springframework.vault.authentication

Class GcpIamAuthenticationOptions

java.lang.Object

org.springframework.vault.authentication.GcpIamAuthenticationOptions

public class GcpIamAuthenticationOptions
extends Object

Authentication options for GcpIamAuthentication.

Authentication options provide the path, a GcpCredentialSupplier, role and JWT expiry for GCP IAM authentication. Instances of this class are immutable once constructed.

Since:

2.1

Author:

Mark Paluch, Magnus Jungsbluth

See Also:

GcpIamAuthentication, builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder Builder for GcpIamAuthenticationOptions.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_GCP_AUTHENTICATION_PATH

Method Summary

Modifier and Type	Method and Description
static GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder	builder()
Clock	getClock()
GcpCredentialSupplier	getCredentialSupplier()
Duration	getJwtValidity()
String	getPath()
GcpProjectIdAccessor	getProjectIdAccessor()
String	getRole()
GcpServiceAccountIdAccessor	getServiceAccountIdAccessor()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_GCP_AUTHENTICATION_PATH

public static final String DEFAULT_GCP_AUTHENTICATION_PATH

See Also:

Constant Field Values

Method Detail

builder

public static GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder builder()

Returns:

a new GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder.

getPath

public String getPath()

Returns:

the path of the gcp authentication backend mount.

getCredentialSupplier

public GcpCredentialSupplier getCredentialSupplier()

Returns:

the gcp Credential supplier.

getRole

public String getRole()

Returns:

name of the role against which the login is being attempted.

getJwtValidity

public Duration getJwtValidity()

Returns:

Duration of the JWT to generate.

getClock

public Clock getClock()

Returns:

Clock used to calculate epoch seconds until the JWT expires.

getServiceAccountIdAccessor

public GcpServiceAccountIdAccessor getServiceAccountIdAccessor()

Returns:

the service account id to use as sub/iss claims.

Since:

2.1

getProjectIdAccessor

public GcpProjectIdAccessor getProjectIdAccessor()

Returns:

GCP project id accessor to obtain the project id of GCP IAM API calls.

Since:

2.1