com.bettercloud.vault.api

Class Auth

java.lang.Object

com.bettercloud.vault.api.Auth

public class Auth
extends java.lang.Object

The implementing class for operations on Vault's /v1/auth/* REST endpoints.

This class is not intended to be constructed directly. Rather, it is meant to used by way of Vault in a DSL-style builder pattern. See the Javadoc comments of each public method for usage examples.

Constructor Summary

Constructors

Constructor and Description
Auth(VaultConfig config)

Method Summary

Modifier and Type	Method and Description
AuthResponse	loginByAppID(java.lang.String path, java.lang.String appId, java.lang.String userId) Basic login operation to authenticate to an app-id backend.
AuthResponse	loginByUsernamePassword(java.lang.String path, java.lang.String password) Basic login operation to authenticate to a Username & Password backend.
AuthResponse	renewSelf() Renews the lease associated with the calling token.
AuthResponse	renewSelf(long increment) Renews the lease associated with the calling token.

Methods inherited from class java.lang.Object

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

Constructor Detail

Auth

public Auth(VaultConfig config)

Method Detail

loginByAppID

public AuthResponse loginByAppID(java.lang.String path,
                                 java.lang.String appId,
                                 java.lang.String userId)
                          throws VaultException

Basic login operation to authenticate to an app-id backend. Example usage:

 final AuthResponse response = vault.auth().loginByAppID("app-id/login", "app_id", "user_id");

 final String token = response.getAuthClientToken());
 

Parameters:

path - The path on which the authentication is performed (e.g. auth/app-id/login)

appId - The app-id used for authentication

userId - The user-id used for authentication

Returns:

The auth token

Throws:

VaultException

loginByUsernamePassword

public AuthResponse loginByUsernamePassword(java.lang.String path,
                                            java.lang.String password)
                                     throws VaultException

Basic login operation to authenticate to a Username & Password backend. Example usage:

 final AuthResponse response = vault.auth().loginByUsernamePassword("userpass/login/test", "password");

 final String token = response.getAuthClientToken());
 

Parameters:

path - The path on which the authentication is performed (e.g. auth/userpass/login/username)

password - The password used for authentication

Returns:

The auth token

Throws:

VaultException

renewSelf

public AuthResponse renewSelf()
                       throws VaultException

Renews the lease associated with the calling token. This version of the method tells Vault to use the default lifespan for the new lease.

Returns:

Throws:

VaultException

renewSelf

public AuthResponse renewSelf(long increment)
                       throws VaultException

Renews the lease associated with the calling token. This version of the method accepts a parameter to explicitly declare how long the new lease period should be (in seconds). The Vault documentation suggests that this value may be ignored, however.

Parameters:

increment - The number of seconds requested for the new lease lifespan

Throws:

VaultException