Package org.springframework.vault.authentication

Class UsernamePasswordAuthenticationOptions

java.lang.Object

org.springframework.vault.authentication.UsernamePasswordAuthenticationOptions

public class UsernamePasswordAuthenticationOptions
extends Object

Authentication options for UsernamePasswordAuthentication.

Since:

2.4

Author:

Mikhael Sokolov, Mark Paluch

See Also:

• UsernamePasswordAuthentication
• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder	Builder for UsernamePasswordAuthenticationOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_USERPASS_AUTHENTICATION_PATH

Method Summary

Modifier and Type	Method	Description
static UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder	builder()
CharSequence	getPassword()
String	getPath()
CharSequence	getTotp()
String	getUsername()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_USERPASS_AUTHENTICATION_PATH

public static final String DEFAULT_USERPASS_AUTHENTICATION_PATH

See Also:

• Constant Field Values

Method Details

builder

public static UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder builder()

Returns:

a new UsernamePasswordAuthenticationOptions.UsernamePasswordAuthenticationBuilder.

getPath

public String getPath()

Returns:

the path of the userpass authentication backend mount.

getUsername

public String getUsername()

Returns:

the username.

getPassword

public CharSequence getPassword()

Returns:

the password.

getTotp

@Nullable
public CharSequence getTotp()

Returns:

the totp (one-time-token). Can be null.