org.springframework.vault.core

Interface VaultTokenOperations

All Known Implementing Classes:

VaultTokenTemplate

public interface VaultTokenOperations

Interface that specifies token-related operations.

Author:

Mark Paluch

See Also:

Auth Backend: Token

Method Summary

Modifier and Type	Method and Description
VaultTokenResponse	create() Create a new token.
VaultTokenResponse	create(VaultTokenRequest request) Create a new token for the given VaultTokenRequest.
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 Detail

create

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

createOrphan

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/{token}

revoke

void revoke(VaultToken vaultToken)

Revoke a VaultToken.

Parameters:

vaultToken - must not be null.

See Also:

POST /auth/token/revoke/{token}

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/{token}