hvac.api¶
Collection of Vault API endpoint classes.
-
class
hvac.api.
AuthMethods
(adapter)[source]¶ Bases:
hvac.api.vault_api_category.VaultApiCategory
Auth Methods.
-
implemented_classes
= [<class 'hvac.api.auth_methods.azure.Azure'>, <class 'hvac.api.auth_methods.github.Github'>, <class 'hvac.api.auth_methods.gcp.Gcp'>, <class 'hvac.api.auth_methods.kubernetes.Kubernetes'>, <class 'hvac.api.auth_methods.ldap.Ldap'>, <class 'hvac.api.auth_methods.mfa.Mfa'>, <class 'hvac.api.auth_methods.okta.Okta'>, <class 'hvac.api.auth_methods.radius.Radius'>]¶
-
unimplemented_classes
= ['AppId', 'AppRole', 'AliCloud', 'Aws', 'Jwt', 'Cert', 'Token', 'UserPass']¶
-
-
class
hvac.api.
SecretsEngines
(adapter)[source]¶ Bases:
hvac.api.vault_api_category.VaultApiCategory
Secrets Engines.
-
implemented_classes
= [<class 'hvac.api.secrets_engines.aws.Aws'>, <class 'hvac.api.secrets_engines.azure.Azure'>, <class 'hvac.api.secrets_engines.gcp.Gcp'>, <class 'hvac.api.secrets_engines.identity.Identity'>, <class 'hvac.api.secrets_engines.kv.Kv'>, <class 'hvac.api.secrets_engines.transit.Transit'>]¶
-
unimplemented_classes
= ['Ad', 'AliCloud', 'Azure', 'Consul', 'Database', 'GcpKms', 'Nomad', 'Pki', 'RabbitMq', 'Ssh', 'TOTP', 'Cassandra', 'MongoDb', 'Mssql', 'MySql', 'PostgreSql']¶
-
-
class
hvac.api.
SystemBackend
(adapter)[source]¶ Bases:
hvac.api.vault_api_category.VaultApiCategory
,hvac.api.system_backend.audit.Audit
,hvac.api.system_backend.auth.Auth
,hvac.api.system_backend.health.Health
,hvac.api.system_backend.init.Init
,hvac.api.system_backend.key.Key
,hvac.api.system_backend.leader.Leader
,hvac.api.system_backend.lease.Lease
,hvac.api.system_backend.mount.Mount
,hvac.api.system_backend.policy.Policy
,hvac.api.system_backend.seal.Seal
,hvac.api.system_backend.wrapping.Wrapping
-
__init__
(adapter)[source]¶ API Category class constructor.
Parameters: adapter (hvac.adapters.Adapter) – Instance of hvac.adapters.Adapter
; used for performing HTTP requests.
-
implemented_classes
= [<class 'hvac.api.system_backend.audit.Audit'>, <class 'hvac.api.system_backend.auth.Auth'>, <class 'hvac.api.system_backend.health.Health'>, <class 'hvac.api.system_backend.init.Init'>, <class 'hvac.api.system_backend.key.Key'>, <class 'hvac.api.system_backend.leader.Leader'>, <class 'hvac.api.system_backend.lease.Lease'>, <class 'hvac.api.system_backend.mount.Mount'>, <class 'hvac.api.system_backend.policy.Policy'>, <class 'hvac.api.system_backend.seal.Seal'>, <class 'hvac.api.system_backend.wrapping.Wrapping'>]¶
-
unimplemented_classes
= []¶
-
-
class
hvac.api.
VaultApiBase
(adapter)[source]¶ Bases:
object
Base class for API endpoints.
-
__init__
(adapter)[source]¶ Default api class constructor.
Parameters: adapter (hvac.adapters.Adapter) – Instance of hvac.adapters.Adapter
; used for performing HTTP requests.
-
-
class
hvac.api.
VaultApiCategory
(adapter)[source]¶ Bases:
hvac.api.vault_api_base.VaultApiBase
Base class for API categories.
-
__init__
(adapter)[source]¶ API Category class constructor.
Parameters: adapter (hvac.adapters.Adapter) – Instance of hvac.adapters.Adapter
; used for performing HTTP requests.
-
adapter
¶ Retrieve the adapter instance under the “_adapter” property in use by this class.
Returns: The adapter instance in use by this class. Return type: hvac.adapters.Adapter
-
static
get_private_attr_name
(class_name)[source]¶ Helper method to prepend a leading underscore to a provided class name.
Parameters: class_name (str|unicode) – Name of a class under this category. Returns: The private attribute label for the provided class. Return type: str
-
implemented_classes
¶ List of implemented classes under this category.
Returns: List of implemented classes under this category. Return type: List[hvac.api.VaultApiBase]
-
unimplemented_classes
¶ List of known unimplemented classes under this category.
Returns: List of known unimplemented classes under this category. Return type: List[str]
-