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

Interface AppRoleAuth

public interface AppRoleAuth
Vault authentication method for AppRole. All methods block the current thread. This implementation is not suitable for reactive programming. Use AppRoleAuthRx in reactive code.

  • Method Details

    • create

      static AppRoleAuth create(AppRoleAuthRx reactive)
      Create AppRole blocking API from its reactive counterpart.
      Parameters:
      reactive - AppRole reactive API
      Returns:
      AppRole blocking API

    • createAppRole

      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

      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 Optional<String> readRoleId(String appRole)
      Reads the RoleID of an existing AppRole.
      Parameters:
      appRole - name of the AppRole
      Returns:
      role ID
      See Also:

    • readRoleId

      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

      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

      DestroySecretId.Response destroySecretId(DestroySecretId.Request request)
      Destroy an AppRole secret ID.
      Parameters:
      request - destroy secret ID request
      Returns:
      when the id gets destroyed

    • login

      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)