Interface VaultTokenOperations

All Known Implementing Classes:

VaultTokenTemplate

public interface VaultTokenOperations

Interface that specifies token-related operations.

Author:

Mark Paluch, Nanne Baars

See Also:

• Auth Backend: Token

Method Summary

Modifier and Type	Method	Description
default VaultTokenResponse	create()	Create a new token.
default VaultTokenResponse	create(String role)	Create a new token for the given role.
VaultTokenResponse	create(String role, VaultTokenRequest request)	Create a new token for the given role and VaultTokenRequest.
VaultTokenResponse	create(VaultTokenRequest request)	Create a new token for the given VaultTokenRequest.
default VaultTokenResponse	createOrphan()	Create a new orphan token.
VaultTokenResponse	createOrphan(VaultTokenRequest request)	Create a new orphan token for the given VaultTokenRequest.
VaultTokenResponse	renew(VaultToken vaultToken)	Renew a VaultToken.
void	revoke(VaultToken vaultToken)	Revoke a VaultToken.
void	revokeOrphan(VaultToken vaultToken)	Revoke a VaultToken but not its child tokens.

Method Details

create

default VaultTokenResponse create()
                           throws VaultException

Create a new token.

Returns:

a VaultTokenResponse

Throws:

VaultException

See Also:

• POST /auth/token/create

create

VaultTokenResponse create(VaultTokenRequest request)
                   throws VaultException

Create a new token for the given VaultTokenRequest.

Parameters:

request - must not be null.

Returns:

a VaultTokenResponse

Throws:

VaultException

See Also:

• POST /auth/token/create

create

default VaultTokenResponse create(String role)
                           throws VaultException

Create a new token for the given role.

Parameters:

role - must not be null.

Returns:

a VaultTokenResponse

Throws:

VaultException

Since:

3.1

See Also:

• POST /auth/token/create/:role

create

VaultTokenResponse create(String role,
 VaultTokenRequest request)
                   throws VaultException

Create a new token for the given role and VaultTokenRequest.

Parameters:

role - must not be null or empty.

request - must not be null.

Returns:

a VaultTokenResponse

Throws:

VaultException

Since:

3.1

See Also:

• POST /auth/token/create/:role

createOrphan

default VaultTokenResponse createOrphan()

Create a new orphan token.

Returns:

a VaultTokenResponse

See Also:

• POST /auth/token/create-orphan

createOrphan

VaultTokenResponse createOrphan(VaultTokenRequest request)

Create a new orphan token for the given VaultTokenRequest.

Parameters:

request - must not be null.

Returns:

a VaultTokenResponse

See Also:

• POST /auth/token/create-orphan

renew

VaultTokenResponse renew(VaultToken vaultToken)

Renew a VaultToken.

Parameters:

vaultToken - must not be null.

Returns:

a VaultTokenResponse

See Also:

• POST /auth/token/renew

revoke

void revoke(VaultToken vaultToken)

Revoke a VaultToken.

Parameters:

vaultToken - must not be null.

See Also:

• POST /auth/token/revoke

revokeOrphan

void revokeOrphan(VaultToken vaultToken)

Revoke a VaultToken but not its child tokens.

Parameters:

vaultToken - must not be null.

See Also:

• POST /auth/token/revoke-orphan