Module io.helidon.integrations.vault.auths.approle

Package io.helidon.integrations.vault.auths.approle

Interface AppRoleAuthRx

public interface AppRoleAuthRx

Vault authentication method for AppRole.

Field Summary

Fields

Modifier and Type	Field	Description
static AuthMethod<AppRoleAuthRx>	AUTH_METHOD	Authentication method.

Method Summary

Modifier and Type	Method	Description
Single<CreateAppRole.Response>	createAppRole(CreateAppRole.Request appRoleRequest)	Creates a new AppRole or updates an existing AppRole.
Single<DeleteAppRole.Response>	deleteAppRole(DeleteAppRole.Request request)	Deletes an existing AppRole from the method with full control of request.
Single<DestroySecretId.Response>	destroySecretId(DestroySecretId.Request request)	Destroy an AppRole secret ID.
Single<GenerateSecretId.Response>	generateSecretId(GenerateSecretId.Request request)	Generates and issues a new SecretID on an existing AppRole.
Single<Login.Response>	login(Login.Request request)	Issues a Vault token based on the presented credentials.
Single<VaultOptionalResponse<ReadRoleId.Response>>	readRoleId(ReadRoleId.Request request)	Reads the RoleID of an existing AppRole with full control of request and response.
default Single<Optional<String>>	readRoleId(String appRole)	Reads the RoleID of an existing AppRole.

Field Detail

AUTH_METHOD

static final AuthMethod<AppRoleAuthRx> AUTH_METHOD

Authentication method.

Method Detail

createAppRole

Single<CreateAppRole.Response> createAppRole(CreateAppRole.Request appRoleRequest)

Creates a new AppRole or updates an existing AppRole. There can be one or more constraints enabled on the role. It is required to have at least one of them enabled while creating or updating a role.

Parameters:

appRoleRequest - Create AppRole request

Returns:

when the AppRole gets created

deleteAppRole

Single<DeleteAppRole.Response> deleteAppRole(DeleteAppRole.Request request)

Deletes an existing AppRole from the method with full control of request.

Parameters:

request - delete AppRole request

Returns:

when the AppRole gets deleted

readRoleId

default Single<Optional<String>> readRoleId(String appRole)

Reads the RoleID of an existing AppRole.

Parameters:

appRole - name of the AppRole

Returns:

role ID

See Also:

readRoleId(io.helidon.integrations.vault.auths.approle.ReadRoleId.Request)

readRoleId

Single<VaultOptionalResponse<ReadRoleId.Response>> readRoleId(ReadRoleId.Request request)

Reads the RoleID of an existing AppRole with full control of request and response.

Parameters:

request - request with name of the AppRole

Returns:

role ID

generateSecretId

Single<GenerateSecretId.Response> generateSecretId(GenerateSecretId.Request request)

Generates and issues a new SecretID on an existing AppRole. Similar to tokens, the response will also contain a secretIdAccessor value which can be used to read the properties of the SecretID without divulging the SecretID itself, and also to delete the SecretID from the AppRole.

Parameters:

request - generate secret ID request

Returns:

a new secret id response

destroySecretId

Single<DestroySecretId.Response> destroySecretId(DestroySecretId.Request request)

Destroy an AppRole secret ID.

Parameters:

request - destroy secret ID request

Returns:

when the id gets destroyed

login

Single<Login.Response> login(Login.Request request)

Issues a Vault token based on the presented credentials.

Parameters:

request - login request

Returns:

Login response (with Vault token)