Usage Authorization

Java Vault Connector

Usage Examples

Authorization

The connector currently supports four authorization methods.

• Token
• Username & Password
• AppRole
• AppID [deprecated]

Token

Authenticate

VaultConnector connector = ...;
connector.authToken("01234567-89ab-cdef-0123-456789abcdef");

Create new Token

 // Create new token using the builder (supports all current parameters).
 Token token = Token.builder()
                    .withId("token-id")
                    .withDisplayName("token name")
                    .build();
 // Write token to Vault (orphan creation and role binding possible).
 AuthResponse createResponse = connector.createToken(token);

Username & Password

Authenticate

VaultConnector connector = ...;
connector.authUserPass("username", "p4ssw0rd");

AppRole

Authenticate

VaultConnector connector = ...;
// connector.authAppId("role-id", "secret-id");
connector.authAppRole("01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210");

Manage roles and secrets

// Create new role using the builder. Supports all current role parameters.
AppRole role = AppRole.builder("role-name").build();

// Write the new role to Vault.
boolean created = connector.createAppRole(role);

// Lookup the role by name.
AppRoleResponse res = connector.lookupAppRole("role-name");

// Create a new secret with random ID.
AppRoleSecretResponse secret = connector.createAppRoleSecret("role-name");

// Destroy the secret.
boolean destroyed = connector.destroyAppRoleSecret("role-name", secret.getSecret().getId());

AppID

VaultConnector connector = ...;
// connector.authAppId("app-id", "user-id");
connector.authAppId("01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210");