org.springframework.vault.authentication

Class AppRoleAuthentication

java.lang.Object

org.springframework.vault.authentication.AppRoleAuthentication

All Implemented Interfaces:

ClientAuthentication

public class AppRoleAuthentication
extends Object
implements ClientAuthentication

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

See Also:

AppRoleAuthenticationOptions, VaultClient, Auth Backend: AppRole

Constructor Summary

Constructors

Constructor and Description
AppRoleAuthentication(AppRoleAuthenticationOptions options, VaultClient vaultClient) Creates a AppRoleAuthentication using AppRoleAuthenticationOptions and VaultClient.

Method Summary

Modifier and Type	Method and Description
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,
                             VaultClient vaultClient)

Creates a AppRoleAuthentication using AppRoleAuthenticationOptions and VaultClient.

Parameters:

options - must not be null.

vaultClient - must not be null.

Method Detail

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.