Interface AppRoleAuthenticationOptions.SecretId
- Enclosing class:
- AppRoleAuthenticationOptions
public static interface AppRoleAuthenticationOptions.SecretId
SecretId type encapsulating how the secretId is actually obtained. Provides factory
methods to obtain a
AppRoleAuthenticationOptions.SecretId
by wrapping, pull-mode or whether to use a
string literal.- Since:
- 2.0
-
Method Summary
Modifier and TypeMethodDescriptionabsent()
Create aAppRoleAuthenticationOptions.SecretId
that represents an absent secretId.Create aAppRoleAuthenticationOptions.SecretId
that encapsulates a staticsecretId
.pull
(VaultToken initialToken) Create aAppRoleAuthenticationOptions.SecretId
that obtains its value using pull-mode, specifying ainitial token
.wrapped
(VaultToken initialToken) Create aAppRoleAuthenticationOptions.SecretId
object that obtains its value from unwrapping a response using theinitial token
from a Cubbyhole.
-
Method Details
-
wrapped
Create aAppRoleAuthenticationOptions.SecretId
object that obtains its value from unwrapping a response using theinitial token
from a Cubbyhole.- Parameters:
initialToken
- must not be null.- Returns:
AppRoleAuthenticationOptions.SecretId
object that obtains its value from unwrapping a response using theinitial token
.- See Also:
-
pull
Create aAppRoleAuthenticationOptions.SecretId
that obtains its value using pull-mode, specifying ainitial token
. The token policy must allow reading the SecretId fromauth/approle/role/(role-name)/secret-id
.- Parameters:
initialToken
- must not be null.- Returns:
AppRoleAuthenticationOptions.SecretId
that obtains its value using pull-mode.
-
provided
Create aAppRoleAuthenticationOptions.SecretId
that encapsulates a staticsecretId
.- Parameters:
secretId
- must not be null or empty.- Returns:
AppRoleAuthenticationOptions.SecretId
that encapsulates a staticSecretId
.
-
absent
Create aAppRoleAuthenticationOptions.SecretId
that represents an absent secretId. Using this object will not send a secretId during AppRole login.- Returns:
- a
AppRoleAuthenticationOptions.SecretId
that represents an absent secretId
-