Module io.helidon.integrations.vault.auths.token

Package io.helidon.integrations.vault.auths.token

Interface TokenAuthRx

public interface TokenAuthRx

Token authentication method API. See https://www.vaultproject.io/api-docs/auth/token

Field Summary

Fields

Modifier and Type	Field	Description
static AuthMethod<TokenAuthRx>	AUTH_METHOD	Token authentication method.
static String	TYPE_BATCH	Batch token type.
static String	TYPE_DEFAULT	Default token type.
static String	TYPE_SERVICE	Service token type.

Method Summary

Modifier and Type	Method	Description
default Single<CreateToken.Response>	createOrphan()	Create a new orphan token with default configuration.
default Single<CreateToken.Response>	createToken()	Create a new child token with default configuration.
Single<CreateToken.Response>	createToken(CreateToken.Request request)	Create a new token with customized configuration.
Single<CreateTokenRole.Response>	createTokenRole(CreateTokenRole.Request request)	Creates (or replaces) the named role.
Single<DeleteTokenRole.Response>	deleteTokenRole(DeleteTokenRole.Request request)	Delete a named token role.
Single<RenewToken.Response>	renew(RenewToken.Request request)	Renews a lease associated with a token.
Single<RevokeToken.Response>	revoke(RevokeToken.Request request)	Revokes a token and all child tokens.
Single<RevokeAndOrphanToken.Response>	revokeAndOrphan(RevokeAndOrphanToken.Request request)	Revokes a token and orphans all child tokens.

Field Detail

AUTH_METHOD

static final AuthMethod<TokenAuthRx> AUTH_METHOD

Token authentication method.

Documentation: https://www.vaultproject.io/api-docs/auth/token

TYPE_SERVICE

static final String TYPE_SERVICE

Service token type.

See Also:

Constant Field Values

TYPE_BATCH

static final String TYPE_BATCH

Batch token type.

See Also:

Constant Field Values

TYPE_DEFAULT

static final String TYPE_DEFAULT

Default token type.

See Also:

Constant Field Values

Method Detail

createToken

default Single<CreateToken.Response> createToken()

Create a new child token with default configuration.

Returns:

a new token

createOrphan

default Single<CreateToken.Response> createOrphan()

Create a new orphan token with default configuration.

Returns:

a new token

createToken

Single<CreateToken.Response> createToken(CreateToken.Request request)

Create a new token with customized configuration.

Parameters:

request - token request

Returns:

a new token

renew

Single<RenewToken.Response> renew(RenewToken.Request request)

Renews a lease associated with a token. This is used to prevent the expiration of a token, and the automatic revocation of it. Token renewal is possible only if there is a lease associated with it.

Parameters:

request - with token to renew

Returns:

a new token

revoke

Single<RevokeToken.Response> revoke(RevokeToken.Request request)

Revokes a token and all child tokens. When the token is revoked, all dynamic secrets generated with it are also revoked.

Parameters:

request - with token to revoke

Returns:

when revocation finishes

createTokenRole

Single<CreateTokenRole.Response> createTokenRole(CreateTokenRole.Request request)

Creates (or replaces) the named role. Roles enforce specific behavior when creating tokens that allow token functionality that is otherwise not available or would require sudo/root privileges to access. Role parameters, when set, override any provided options to the create endpoints. The role name is also included in the token path, allowing all tokens created against a role to be revoked using the /sys/leases/revoke-prefix endpoint.

Parameters:

request - token role request

Returns:

when creation finishes

deleteTokenRole

Single<DeleteTokenRole.Response> deleteTokenRole(DeleteTokenRole.Request request)

Delete a named token role.

Parameters:

request - with name of the role

Returns:

when deleted

revokeAndOrphan

Single<RevokeAndOrphanToken.Response> revokeAndOrphan(RevokeAndOrphanToken.Request request)

Revokes a token and orphans all child tokens. When the token is revoked, all dynamic secrets generated with it are also revoked. This is a root protected endpoint.

Parameters:

request - with token to revoke

Returns:

when revocation finishes