VaultTOTPSecretEngine (Quarkus - Vault - Runtime 1.0.2 API)

All Known Implementing Classes:

VaultTOTPManager
```
public interface VaultTOTPSecretEngine
```
This service provides access to the TOTP secret engine.

See Also:

TOTP Secrets Engine

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Optional<KeyDefinition>`	`createKey(String name, CreateKeyParameters createKeyParameters)`	Creates or updates a key definition.
`void`	`deleteKey(String name)`	Deletes the key definition.
`String`	`generateCode(String name)`	Generates a new time-based one-time use password based on the named key.
`List<String>`	`listKeys()`	Returns a list of available keys.
`KeyConfiguration`	`readKey(String name)`	Queries the key definition.
`boolean`	`validateCode(String name, String code)`	Validates a time-based one-time use password generated from the named key.

- Method Detail
  - createKey
```
Optional<KeyDefinition> createKey(String name,
                                  CreateKeyParameters createKeyParameters)
```
    Creates or updates a key definition.
    
    Parameters:
    
    name - of the key.
    
    createKeyParameters - required to create or update a key.
    
    Returns:
    
    Barcode and/or URL of the created OTP key.
  - readKey
```
KeyConfiguration readKey(String name)
```
    Queries the key definition.
    
    Parameters:
    
    name - of the key.
    
    Returns:
    
    The key configuration.
  - listKeys
```
List<String> listKeys()
```
    Returns a list of available keys. Only the key names are returned, not any values.
    
    Returns:
    
    List of available keys.
  - deleteKey
```
void deleteKey(String name)
```
    Deletes the key definition.
    
    Parameters:
    
    name - of the key.
  - generateCode
```
String generateCode(String name)
```
    Generates a new time-based one-time use password based on the named key.
    
    Parameters:
    
    name - of the key.
    
    Returns:
    
    The Code.
  - validateCode
```
boolean validateCode(String name,
                     String code)
```
    Validates a time-based one-time use password generated from the named key.
    
    Parameters:
    
    name - of the key.
    
    code - to validate.
    
    Returns:
    
    True if valid, false otherwise.