org.springframework.vault.authentication

Class AppRoleAuthentication

java.lang.Object

org.springframework.vault.authentication.AppRoleAuthentication

All Implemented Interfaces:

AuthenticationStepsFactory, ClientAuthentication

public class AppRoleAuthentication
extends Object
implements ClientAuthentication, AuthenticationStepsFactory

AppRole implementation of ClientAuthentication. RoleId and SecretId (optional) are sent in the login request to Vault to obtain a VaultToken.

AppRoleAuthentication can be configured for push and pull mode by setting AppRoleAuthenticationOptions.getSecretId().

Author:

Mark Paluch, Vincent Le Nair, Christophe Tafani-Dereeper

See Also:

AppRoleAuthenticationOptions, RestOperations, Auth Backend: AppRole

Constructor Summary

Constructors

Constructor and Description
AppRoleAuthentication(AppRoleAuthenticationOptions options, RestOperations restOperations) Create a AppRoleAuthentication using AppRoleAuthenticationOptions and RestOperations.

Method Summary

Modifier and Type	Method and Description
static AuthenticationSteps	createAuthenticationSteps(AppRoleAuthenticationOptions options) Creates a AuthenticationSteps for AppRole authentication given AppRoleAuthenticationOptions.
AuthenticationSteps	getAuthenticationSteps() Get the AuthenticationSteps describing an authentication flow.
VaultToken	login() Return a VaultToken.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppRoleAuthentication

public AppRoleAuthentication(AppRoleAuthenticationOptions options,
                             RestOperations restOperations)

Create a AppRoleAuthentication using AppRoleAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

restOperations - must not be null.

Method Detail

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps(AppRoleAuthenticationOptions options)

Creates a AuthenticationSteps for AppRole authentication given AppRoleAuthenticationOptions.

Parameters:

options - must not be null.

Returns:

AuthenticationSteps for AppRole authentication.

Since:

2.0

login

public VaultToken login()

Description copied from interface: ClientAuthentication

Return a VaultToken. This method can optionally log into Vault to obtain a token.

Specified by:

login in interface ClientAuthentication

Returns:

a VaultToken.

getAuthenticationSteps

public AuthenticationSteps getAuthenticationSteps()

Description copied from interface: AuthenticationStepsFactory

Get the AuthenticationSteps describing an authentication flow.

Specified by:

getAuthenticationSteps in interface AuthenticationStepsFactory

Returns:

the AuthenticationSteps describing an authentication flow.