Package org.springframework.vault.authentication

Class JwtAuthenticationOptions

java.lang.Object

org.springframework.vault.authentication.JwtAuthenticationOptions

public class JwtAuthenticationOptions
extends Object

Authentication options for JwtAuthentication.

Authentication options provide the role and the JWT. JwtAuthenticationOptions can be constructed using builder(). Instances of this class are immutable once constructed.

Since:

3.1

Author:

Nanne Baars, Mark Paluch

See Also:

• JwtAuthentication
• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder	Builder for JwtAuthenticationOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_JWT_AUTHENTICATION_PATH

Method Summary

Modifier and Type	Method	Description
static JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder	builder()
Supplier<String>	getJwtSupplier()
String	getPath()
String	getRole()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_JWT_AUTHENTICATION_PATH

public static final String DEFAULT_JWT_AUTHENTICATION_PATH

See Also:

• Constant Field Values

Method Details

builder

public static JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder builder()

Returns:

a new JwtAuthenticationOptions.JwtAuthenticationOptionsBuilder.

getRole

@Nullable
public String getRole()

Returns:

name of the role against which the login is being attempted. Can be null if not configured.

getJwtSupplier

public Supplier<String> getJwtSupplier()

Returns:

JSON Web Token.

getPath

public String getPath()

Returns:

the path of the JWT authentication backend mount.