Package org.springframework.vault.authentication

Class AppIdAuthentication

java.lang.Object

org.springframework.vault.authentication.AppIdAuthentication

All Implemented Interfaces:

AuthenticationStepsFactory, ClientAuthentication

@Deprecated(since="2.2",
            forRemoval=true)
public class AppIdAuthentication
extends Object
implements ClientAuthentication, AuthenticationStepsFactory

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.2. Use AppRoleAuthentication.

AppId implementation of ClientAuthentication. AppIdAuthentication uses a configured AppIdUserIdMechanism to obtain or calculate a UserId. AppId and UserId are sent in the login request to Vault to obtain a VaultToken.

Author:

Mark Paluch

See Also:

• AppIdAuthenticationOptions
• RestOperations
• Auth Backend: App ID

Constructor Summary

Constructors

Constructor	Description
AppIdAuthentication(AppIdAuthenticationOptions options, RestOperations restOperations)	Deprecated, for removal: This API element is subject to removal in a future version. Create AppIdAuthentication using AppIdAuthenticationOptions and RestOperations.

Method Summary

Modifier and Type	Method	Description
static AuthenticationSteps	createAuthenticationSteps(AppIdAuthenticationOptions options)	Deprecated, for removal: This API element is subject to removal in a future version. Create AuthenticationSteps for AppId authentication given AppIdAuthenticationOptions.
AuthenticationSteps	getAuthenticationSteps()	Deprecated, for removal: This API element is subject to removal in a future version. Get the AuthenticationSteps describing an authentication flow.
VaultToken	login()	Deprecated, for removal: This API element is subject to removal in a future version. Obtain a VaultToken for authenticated Vault access.

Methods inherited from class java.lang.Object

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

Constructor Details

AppIdAuthentication

public AppIdAuthentication(AppIdAuthenticationOptions options,
 RestOperations restOperations)

Deprecated, for removal: This API element is subject to removal in a future version.

Create AppIdAuthentication using AppIdAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

restOperations - must not be null.

Method Details

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps(AppIdAuthenticationOptions options)

Deprecated, for removal: This API element is subject to removal in a future version.

Create AuthenticationSteps for AppId authentication given AppIdAuthenticationOptions.

Parameters:

options - must not be null.

Returns:

AuthenticationSteps for AppId authentication.

Since:

2.0

login

public VaultToken login()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: ClientAuthentication

Obtain a VaultToken for authenticated Vault access.

This method may perform an authentication request to Vault or return a cached or pre-configured token.

Specified by:

login in interface ClientAuthentication

Returns:

the Vault token for subsequent authenticated requests

See Also:

• LoginToken

getAuthenticationSteps

public AuthenticationSteps getAuthenticationSteps()

Deprecated, for removal: This API element is subject to removal in a future version.

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.