hvac
v0.10.5
Overview
Installation
Getting Started
Initialize the Client
Vault Cluster - Initialize and Seal/Unseal
Read and write to secrets engines
KV Secrets Engine - Version 2
KV Secrets Engine - Version 1
Authentication
Basic Token Authentication
LDAP Authentication Example
Usage
Secrets Engines
AWS
Configure Root IAM Credentials
Rotate Root IAM Credentials
Configure Lease
Read Lease
Create or Update Role
Read Role
List Roles
Delete Role
Generate Credentials
Azure
Configure
Read Config
Delete Config
Create Or Update A Role
List Roles
Generate Credentials
GCP
Configure
Read Config
Create Or Update Roleset
Rotate Roleset Account
Rotate Roleset Account Key
Read Roleset
List Rolesets
Delete Roleset
Generate Oauth2 Access Token
Generate Service Account Key
Identity
Entity
Entity Alias
Group
Group Alias
Lookup
Tokens
PKI
Read CA Certificate
Read CA Certificate Chain
Read Certificate
List Certificates
Submit CA Information
Read CRL Configuration
Set CRL Configuration
Read URLs
Set URLs
Read CRL
Rotate CRLs
Generate Intermediate
Set Signed Intermediate
Generate Certificate
Revoke Certificate
Create/Update Role
Read Role
List Roles
Delete Role
Generate Root
Delete Root
Sign Intermediate
Sign Self-Issued
Sign Certificate
Sign Verbatim
Tidy
KV Secrets Engines
Setting the Default KV Version
Explicitly Calling a KV Version Method
Specific KV Version Usage
KV - Version 1
Read a Secret
List Secrets
Create or Update a Secret
Delete a Secret
KV - Version 2
Configuration
Read Configuration
Read Secret Versions
Create/Update Secret
Patch Existing Secret
Delete Latest Version of Secret
Delete Secret Versions
Undelete Secret Versions
Destroy Secret Versions
List Secrets
Read Secret Metadata
Update Metadata
Delete Metadata and All Versions
Transform
Encode/Decode Example
Create/Update Role
Read Role
List Roles
Delete Role
Create/Update Transformation
Read Transformation
List Transformations
Delete Transformation
Create/Update Template
Read Template
List Templates
Delete Template
Create/Update Alphabet
Read Alphabet
List Alphabets
Delete Alphabet
Transit
Create Key
Read Key
List Keys
Delete Key
Update Key Configuration
Rotate Key
Export Key
Encrypt Data
Decrypt Data
Rewrap Data
Generate Data Key
Generate Random Bytes
Hash Data
Generate Hmac
Sign Data
Verify Signed Data
Backup Key
Restore Key
Trim Key
Auth Methods
Approle
Authentication
AWS
IAM Authentication
EC2 Authentication
Methods
Azure
Enabling the Auth Method
Configure
Read Config
Delete Config
Create a Role
Read A Role
List Roles
Delete A Role
Login
GCP
Enabling the Auth Method
Configure
Read Config
Delete Config
Create Role
Edit Service Accounts On IAM Role
Edit Labels On GCE Role
Read A Role
List Roles
Delete A Role
Login
GitHub
Enabling the Auth Method
Configure Connection Parameters
Reading Configuration
Mapping Teams to Policies
Reading Team Mappings
Mapping Users to Policies
Reading User Mappings
Authentication / Login
JWT/OIDC
Enabling
Configure
Read Config
Create Role
Read Role
List Roles
Delete Role
OIDC Authorization URL Request
JWT Login
Kubernetes
Authentication
LDAP
Enabling the LDAP Auth Method
Configure LDAP Auth Method Settings
Reading the LDAP Auth Method Configuration
Create or Update a LDAP Group Mapping
List LDAP Group Mappings
Read LDAP Group Mapping
Deleting a LDAP Group Mapping
Creating or Updating a LDAP User Mapping
Listing LDAP User Mappings
Reading a LDAP User Mapping
Deleting a Configured User Mapping
Authentication / Login
MFA
Configure MFA Auth Method Settings
Reading the MFA Auth Method Configuration
Configure Duo MFA Type Access Credentials
Configure Duo MFA Type Behavior
Read Duo MFA Type Behavior
Authentication / Login
Okta
Enabling the Auth Method
Configure
Read Config
List Users
Register User
Read User
Delete User
List Groups
Register Group
Read Group
Delete Group
Login
Token
Authentication
Token Management
Authenticate to different auth backends
System Backend
Audit
Examples
List Enabled Audit Devices
Enable Audit Device
Disable Audit Device
Calculate Hash
Auth
Examples
List Auth Methods
Enable Auth Method
Disable Auth Method
Read Auth Method Tuning
Tune Auth Method
Health
Read Status
Init
Read Status
Is Initialized
Initialize
Key
Read Root Generation Progress
Start Root Token Generation
Cancel Root Generation
Generate Root
Get Encryption Key Status
Rotate Encryption Key
Read Rekey Progress
Start Rekey
Cancel Rekey
Rekey
Rekey Multi
Read Rekey Verify Progress
Cancel Rekey Verify
Rekey Verify
Rekey Verify Multi
Read Backup Keys
Leader
Read Leader Status
Step Down
Lease
View and Manage Leases
Read Lease
List Leases
Renew Lease
Revoke Lease
Revoke Prefix
Revoke Force
Mount
Manipulate secret backends
List Mounted Secrets Engines
Enable Secrets Engine
Disable Secrets Engine
Read Mount Configuration
Tune Mount Configuration
Move Backend
Namespace
Create Namespace
List Namespaces
Delete Namespace
Policy
Manipulate policies
List Policies
Read Policy
Create Or Update Policy
Delete Policy
Raft
Join Raft Cluster
Read Raft Configuration
Remove Raft Node
Seal
Seal Status
Is Sealed
Read Seal Status
Seal
Submit Unseal Key
Submit Unseal Keys
Wrapping
Unwrap
Is Sealed
Initialize and seal/unseal
Advanced Usage
Making Use of Private CA
Custom Requests / HTTP Adapter
Vault Agent Unix Socket Listener
Source Reference
hvac.v1
hvac.api
hvac.api.auth_methods
hvac.api.secrets_engines
hvac.api.system_backend
hvac.utils
hvac.aws_utils
hvac.adapters
hvac.exceptions
Contributing
Typical Development Environment Setup
Testing
Updating Requirements
Documentation
Adding New Documentation Files
Testing Docs
Examples
Backwards Compatibility Breaking Changes
Creating / Publishing Releases
Changelog
0.10.5 (July 26th, 2020)
🚀 Features
🐛 Bug Fixes
📚 Documentation
🧰 Miscellaneous
0.10.4 (June 16th, 2020)
🚀 Features
📚 Documentation
0.10.3 (May 24th, 2020)
🚀 Features
0.10.2 (May 19th, 2020)
🚀 Features
🐛 Bug Fixes
📚 Documentation
0.10.1 (April 7th, 2020)
💥 Breaking Changes
🚀 Features
🐛 Bug Fixes
0.10.0 (February 26th, 2020)
🚀 Features
📚 Documentation
🧰 Miscellaneous
0.9.6 (November 20th, 2019)
🚀 Features
📚 Documentation
🧰 Miscellaneous
0.9.5 (July 19th, 2019)
🚀 Features
📚 Documentation
0.9.4 (July 18th, 2019)
🚀 Features
🐛 Bug Fixes
📚 Documentation
🧰 Miscellaneous
0.9.3 (July 7th, 2019)
🚀 Features
🐛 Bug Fixes
📚 Documentation
🧰 Miscellaneous
0.9.2 (June 8th, 2019)
0.9.1 (May 25th, 2019)
0.9.0 (May 23rd, 2019)
0.8.2 (April 4th, 2019)
0.8.1 (March 31st, 2019)
0.8.0 (March 29th, 2019)
0.7.2 (January 1st, 2019)
0.7.1 (December 19th, 2018)
0.7.0 (November 1st, 2018)
0.6.4 (September 5th, 2018)
0.6.3 (August 8th, 2018)
0.6.2 (July 19th, 2018)
0.6.1 (July 5th, 2018)
0.6.0 (June 14, 2018)
0.5.0 (February 20, 2018)
0.4.0 (February 1, 2018)
0.3.0 (November 9, 2017)
0.2.17 (December 15, 2016)
0.2.16 (September 12, 2016)
0.2.15 (June 22nd, 2016)
0.2.14 (June 2nd, 2016)
0.2.13 (May 31st, 2016)
0.2.12 (May 12th, 2016)
0.2.10 (April 8th, 2016)
0.2.9 (March 18th, 2016)
0.2.8 (February 2nd, 2016)
0.2.7 (December 16th, 2015)
0.2.6 (October 30th, 2015)
0.2.5 (September 29th, 2015)
0.2.4 (July 23rd, 2015)
0.2.3 (July 18th, 2015)
0.2.2 (June 12th, 2015)
0.2.1 (June 3rd, 2015)
0.2.0 (May 25th, 2015)
0.1.1 (May 20th, 2015)
0.1.0 (May 17th, 2015)
hvac
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
__init__() (hvac.adapters.Adapter method)
(hvac.api.secrets_engines.Kv method)
(hvac.api.system_backend.SystemBackend method)
(hvac.api.SystemBackend method)
(hvac.api.VaultApiBase method)
(hvac.api.VaultApiCategory method)
(hvac.aws_utils.SigV4Auth method)
(hvac.exceptions.VaultError method)
(hvac.v1.Client method)
A
ActiveDirectory (class in hvac.api.secrets_engines)
Adapter (class in hvac.adapters)
adapter() (hvac.api.VaultApiCategory property)
(hvac.v1.Client property)
add_auth() (hvac.aws_utils.SigV4Auth method)
allow_redirects() (hvac.v1.Client property)
allowed_kv_versions (hvac.api.secrets_engines.Kv attribute)
Audit (class in hvac.api.system_backend)
audit_hash() (hvac.v1.Client method)
Auth (class in hvac.api.system_backend)
auth() (hvac.adapters.Adapter method)
(hvac.v1.Client property)
auth_app_id() (hvac.v1.Client method)
auth_approle() (hvac.v1.Client method)
auth_aws_iam() (hvac.v1.Client method)
auth_cubbyhole() (hvac.v1.Client method)
auth_ec2() (hvac.v1.Client method)
auth_gcp() (hvac.v1.Client method)
auth_github() (hvac.v1.Client method)
auth_kubernetes() (hvac.v1.Client method)
auth_ldap() (hvac.v1.Client method)
auth_tls() (hvac.v1.Client method)
auth_userpass() (hvac.v1.Client method)
AuthMethods (class in hvac.api)
(class in hvac.api.auth_methods)
Aws (class in hvac.api.auth_methods)
(class in hvac.api.secrets_engines)
Azure (class in hvac.api.auth_methods)
(class in hvac.api.secrets_engines)
B
backup_key() (hvac.api.secrets_engines.Transit method)
BadGateway
C
calculate_hash() (hvac.api.system_backend.Audit method)
cancel_generate_root() (hvac.v1.Client method)
cancel_rekey() (hvac.api.system_backend.Key method)
(hvac.v1.Client method)
cancel_rekey_verify() (hvac.api.system_backend.Key method)
cancel_root_generation() (hvac.api.system_backend.Key method)
Capabilities (class in hvac.api.system_backend)
Client (class in hvac.v1)
close() (hvac.adapters.Adapter method)
(hvac.v1.Client method)
comma_delimited_to_list() (in module hvac.utils)
configure() (hvac.api.auth_methods.Aws method)
(hvac.api.auth_methods.Azure method)
(hvac.api.auth_methods.Gcp method)
(hvac.api.auth_methods.Github method)
(hvac.api.auth_methods.JWT method)
(hvac.api.auth_methods.Kubernetes method)
(hvac.api.auth_methods.Ldap method)
(hvac.api.auth_methods.Mfa method)
(hvac.api.auth_methods.Okta method)
(hvac.api.auth_methods.Radius method)
(hvac.api.secrets_engines.ActiveDirectory method)
(hvac.api.secrets_engines.Azure method)
(hvac.api.secrets_engines.Database method)
(hvac.api.secrets_engines.Gcp method)
(hvac.api.secrets_engines.KvV2 method)
(hvac.api.secrets_engines.RabbitMQ method)
configure_duo_access() (hvac.api.auth_methods.Mfa method)
configure_duo_behavior() (hvac.api.auth_methods.Mfa method)
configure_identity_integration() (hvac.api.auth_methods.Aws method)
configure_identity_whitelist_tidy() (hvac.api.auth_methods.Aws method)
configure_lease() (hvac.api.secrets_engines.Aws method)
(hvac.api.secrets_engines.RabbitMQ method)
configure_role_tag_blacklist_tidy() (hvac.api.auth_methods.Aws method)
configure_root_iam_credentials() (hvac.api.secrets_engines.Aws method)
configure_tokens_backend() (hvac.api.secrets_engines.Identity method)
create_app_id() (hvac.v1.Client method)
create_certificate_configuration() (hvac.api.auth_methods.Aws method)
create_ec2_role() (hvac.v1.Client method)
create_ec2_role_tag() (hvac.v1.Client method)
create_key() (hvac.api.secrets_engines.Transit method)
create_kubernetes_configuration() (hvac.v1.Client method)
create_kubernetes_role() (hvac.v1.Client method)
create_named_key() (hvac.api.secrets_engines.Identity method)
create_namespace() (hvac.api.system_backend.Namespace method)
create_or_update_alphabet() (hvac.api.secrets_engines.Transform method)
create_or_update_entity() (hvac.api.secrets_engines.Identity method)
create_or_update_entity_alias() (hvac.api.secrets_engines.Identity method)
create_or_update_entity_by_name() (hvac.api.secrets_engines.Identity method)
create_or_update_group() (hvac.api.auth_methods.Ldap method)
(hvac.api.secrets_engines.Identity method)
create_or_update_group_alias() (hvac.api.secrets_engines.Identity method)
create_or_update_group_by_name() (hvac.api.secrets_engines.Identity method)
create_or_update_policy() (hvac.api.system_backend.Policy method)
create_or_update_role() (hvac.api.secrets_engines.ActiveDirectory method)
(hvac.api.secrets_engines.Aws method)
(hvac.api.secrets_engines.Azure method)
(hvac.api.secrets_engines.Identity method)
(hvac.api.secrets_engines.Pki method)
(hvac.api.secrets_engines.Transform method)
create_or_update_roleset() (hvac.api.secrets_engines.Gcp method)
create_or_update_secret() (hvac.api.secrets_engines.KvV1 method)
(hvac.api.secrets_engines.KvV2 method)
create_or_update_template() (hvac.api.secrets_engines.Transform method)
create_or_update_transformation() (hvac.api.secrets_engines.Transform method)
create_or_update_user() (hvac.api.auth_methods.Ldap method)
(hvac.api.auth_methods.Userpass method)
create_role() (hvac.api.auth_methods.Aws method)
(hvac.api.auth_methods.Azure method)
(hvac.api.auth_methods.Gcp method)
(hvac.api.auth_methods.JWT method)
(hvac.api.auth_methods.Kubernetes method)
(hvac.api.auth_methods.OIDC method)
(hvac.api.secrets_engines.Database method)
(hvac.api.secrets_engines.RabbitMQ method)
(hvac.v1.Client method)
create_role_custom_secret_id() (hvac.v1.Client method)
create_role_secret_id() (hvac.v1.Client method)
create_role_tags() (hvac.api.auth_methods.Aws method)
create_sts_role() (hvac.api.auth_methods.Aws method)
create_token() (hvac.v1.Client method)
create_token_role() (hvac.v1.Client method)
create_user_id() (hvac.v1.Client method)
create_userpass() (hvac.v1.Client method)
create_vault_ec2_certificate_configuration() (hvac.v1.Client method)
create_vault_ec2_client_configuration() (hvac.v1.Client method)
D
Database (class in hvac.api.secrets_engines)
decode() (hvac.api.secrets_engines.Transform method)
decrypt_data() (hvac.api.secrets_engines.Transit method)
default_kv_version() (hvac.api.secrets_engines.Kv property)
DEFAULT_PATH (hvac.api.auth_methods.JWT attribute)
(hvac.api.auth_methods.OIDC attribute)
delete() (hvac.adapters.Adapter method)
(hvac.v1.Client method)
delete_alphabet() (hvac.api.secrets_engines.Transform method)
delete_app_id() (hvac.v1.Client method)
delete_blacklist_tags() (hvac.api.auth_methods.Aws method)
delete_certificate_configuration() (hvac.api.auth_methods.Aws method)
delete_config() (hvac.api.auth_methods.Aws method)
(hvac.api.auth_methods.Azure method)
(hvac.api.auth_methods.Gcp method)
(hvac.api.secrets_engines.Azure method)
delete_connection() (hvac.api.secrets_engines.Database method)
delete_ec2_role() (hvac.v1.Client method)
delete_entity() (hvac.api.secrets_engines.Identity method)
delete_entity_alias() (hvac.api.secrets_engines.Identity method)
delete_entity_by_name() (hvac.api.secrets_engines.Identity method)
delete_group() (hvac.api.auth_methods.Ldap method)
(hvac.api.auth_methods.Okta method)
(hvac.api.secrets_engines.Identity method)
delete_group_alias() (hvac.api.secrets_engines.Identity method)
delete_group_by_name() (hvac.api.secrets_engines.Identity method)
delete_identity_whitelist_entries() (hvac.api.auth_methods.Aws method)
delete_identity_whitelist_tidy() (hvac.api.auth_methods.Aws method)
delete_key() (hvac.api.secrets_engines.Transit method)
delete_kubernetes_role() (hvac.v1.Client method)
delete_latest_version_of_secret() (hvac.api.secrets_engines.KvV2 method)
delete_metadata_and_all_versions() (hvac.api.secrets_engines.KvV2 method)
delete_named_key() (hvac.api.secrets_engines.Identity method)
delete_namespace() (hvac.api.system_backend.Namespace method)
delete_policy() (hvac.api.system_backend.Policy method)
(hvac.v1.Client method)
delete_role() (hvac.api.auth_methods.Aws method)
(hvac.api.auth_methods.Azure method)
(hvac.api.auth_methods.Gcp method)
(hvac.api.auth_methods.JWT method)
(hvac.api.auth_methods.Kubernetes method)
(hvac.api.secrets_engines.ActiveDirectory method)
(hvac.api.secrets_engines.Aws method)
(hvac.api.secrets_engines.Database method)
(hvac.api.secrets_engines.Identity method)
(hvac.api.secrets_engines.Pki method)
(hvac.api.secrets_engines.RabbitMQ method)
(hvac.api.secrets_engines.Transform method)
(hvac.v1.Client method)
delete_role_secret_id() (hvac.v1.Client method)
delete_role_secret_id_accessor() (hvac.v1.Client method)
delete_role_tag_blacklist_tidy() (hvac.api.auth_methods.Aws method)
delete_roleset() (hvac.api.secrets_engines.Gcp method)
delete_root() (hvac.api.secrets_engines.Pki method)
delete_secret() (hvac.api.secrets_engines.KvV1 method)
delete_secret_versions() (hvac.api.secrets_engines.KvV2 method)
delete_sts_role() (hvac.api.auth_methods.Aws method)
delete_template() (hvac.api.secrets_engines.Transform method)
delete_token_role() (hvac.v1.Client method)
delete_transformation() (hvac.api.secrets_engines.Transform method)
delete_user() (hvac.api.auth_methods.Ldap method)
(hvac.api.auth_methods.Okta method)
(hvac.api.auth_methods.Radius method)
(hvac.api.auth_methods.Userpass method)
delete_user_id() (hvac.v1.Client method)
delete_userpass() (hvac.v1.Client method)
delete_vault_ec2_client_configuration() (hvac.v1.Client method)
deprecated_method() (in module hvac.utils)
destroy_secret_versions() (hvac.api.secrets_engines.KvV2 method)
disable_audit_backend() (hvac.v1.Client method)
disable_audit_device() (hvac.api.system_backend.Audit method)
disable_auth_backend() (hvac.v1.Client method)
disable_auth_method() (hvac.api.system_backend.Auth method)
disable_secret_backend() (hvac.v1.Client method)
disable_secrets_engine() (hvac.api.system_backend.Mount method)
E
ec2_login() (hvac.api.auth_methods.Aws method)
edit_labels_on_gce_role() (hvac.api.auth_methods.Gcp method)
edit_service_accounts_on_iam_role() (hvac.api.auth_methods.Gcp method)
enable_audit_backend() (hvac.v1.Client method)
enable_audit_device() (hvac.api.system_backend.Audit method)
enable_auth_backend() (hvac.v1.Client method)
enable_auth_method() (hvac.api.system_backend.Auth method)
enable_secret_backend() (hvac.v1.Client method)
enable_secrets_engine() (hvac.api.system_backend.Mount method)
encode() (hvac.api.secrets_engines.Transform method)
encrypt_data() (hvac.api.secrets_engines.Transit method)
export_key() (hvac.api.secrets_engines.Transit method)
F
Forbidden
force_restore_raft_snapshot() (hvac.api.system_backend.Raft method)
format_url() (in module hvac.utils)
G
Gcp (class in hvac.api.auth_methods)
(class in hvac.api.secrets_engines)
generate_certificate() (hvac.api.secrets_engines.Pki method)
generate_credentials() (hvac.api.secrets_engines.Aws method)
(hvac.api.secrets_engines.Azure method)
(hvac.api.secrets_engines.Database method)
(hvac.api.secrets_engines.RabbitMQ method)
generate_data_key() (hvac.api.secrets_engines.Transit method)
generate_hmac() (hvac.api.secrets_engines.Transit method)
generate_intermediate() (hvac.api.secrets_engines.Pki method)
generate_method_deprecation_message() (in module hvac.utils)
generate_oauth2_access_token() (hvac.api.secrets_engines.Gcp method)
generate_property_deprecation_message() (in module hvac.utils)
generate_random_bytes() (hvac.api.secrets_engines.Transit method)
generate_root() (hvac.api.secrets_engines.Pki method)
(hvac.api.system_backend.Key method)
(hvac.v1.Client method)
generate_root_status() (hvac.v1.Client property)
generate_service_account_key() (hvac.api.secrets_engines.Gcp method)
generate_signed_id_token() (hvac.api.secrets_engines.Identity method)
generate_sigv4_auth_request() (in module hvac.aws_utils)
get() (hvac.adapters.Adapter method)
get_app_id() (hvac.v1.Client method)
get_auth_backend_tuning() (hvac.v1.Client method)
get_backed_up_keys() (hvac.v1.Client method)
get_capabilities() (hvac.api.system_backend.Capabilities method)
get_ec2_role() (hvac.v1.Client method)
get_encryption_key_status() (hvac.api.system_backend.Key method)
get_kubernetes_configuration() (hvac.v1.Client method)
get_kubernetes_role() (hvac.v1.Client method)
get_login_token() (hvac.adapters.Adapter method)
(hvac.adapters.JSONAdapter method)
(hvac.adapters.RawAdapter method)
get_policy() (hvac.v1.Client method)
get_private_attr_name() (hvac.api.VaultApiCategory static method)
get_role() (hvac.v1.Client method)
get_role_id() (hvac.v1.Client method)
get_role_secret_id() (hvac.v1.Client method)
get_role_secret_id_accessor() (hvac.v1.Client method)
get_secret_backend_tuning() (hvac.v1.Client method)
get_token_from_env() (in module hvac.utils)
get_user_id() (hvac.v1.Client method)
get_vault_ec2_certificate_configuration() (hvac.v1.Client method)
get_vault_ec2_client_configuration() (hvac.v1.Client method)
getattr_with_deprecated_properties() (in module hvac.utils)
Github (class in hvac.api.auth_methods)
H
ha_status() (hvac.v1.Client property)
hash_data() (hvac.api.secrets_engines.Transit method)
head() (hvac.adapters.Adapter method)
Health (class in hvac.api.system_backend)
hvac.adapters
module
hvac.api
module
hvac.api.auth_methods
module
hvac.api.secrets_engines
module
hvac.api.system_backend
module
hvac.aws_utils
module
hvac.exceptions
module
hvac.utils
module
hvac.v1
module
I
iam_login() (hvac.api.auth_methods.Aws method)
Identity (class in hvac.api.secrets_engines)
implemented_classes (hvac.api.auth_methods.AuthMethods attribute)
(hvac.api.AuthMethods attribute)
(hvac.api.secrets_engines.SecretsEngines attribute)
(hvac.api.SecretsEngines attribute)
(hvac.api.system_backend.SystemBackend attribute)
(hvac.api.SystemBackend attribute)
implemented_classes() (hvac.api.VaultApiCategory property)
Init (class in hvac.api.system_backend)
initialize() (hvac.api.system_backend.Init method)
(hvac.v1.Client method)
InternalServerError
introspect_signed_id_token() (hvac.api.secrets_engines.Identity method)
InvalidPath
InvalidRequest
is_authenticated() (hvac.v1.Client method)
is_initialized() (hvac.api.system_backend.Init method)
(hvac.v1.Client method)
is_sealed() (hvac.api.system_backend.Seal method)
(hvac.v1.Client method)
J
join_raft_cluster() (hvac.api.system_backend.Raft method)
JSONAdapter (class in hvac.adapters)
JWT (class in hvac.api.auth_methods)
jwt_login() (hvac.api.auth_methods.JWT method)
K
Key (class in hvac.api.system_backend)
key_status() (hvac.v1.Client property)
Kubernetes (class in hvac.api.auth_methods)
Kv (class in hvac.api.secrets_engines)
KvV1 (class in hvac.api.secrets_engines)
KvV2 (class in hvac.api.secrets_engines)
L
Ldap (class in hvac.api.auth_methods)
Leader (class in hvac.api.system_backend)
Lease (class in hvac.api.system_backend)
list() (hvac.adapters.Adapter method)
(hvac.v1.Client method)
list_alphabets() (hvac.api.secrets_engines.Transform method)
list_audit_backends() (hvac.v1.Client method)
list_auth_backends() (hvac.v1.Client method)
list_auth_methods() (hvac.api.system_backend.Auth method)
list_blacklist_tags() (hvac.api.auth_methods.Aws method)
list_certificate_configurations() (hvac.api.auth_methods.Aws method)
list_certificates() (hvac.api.secrets_engines.Pki method)
list_connections() (hvac.api.secrets_engines.Database method)
list_ec2_roles() (hvac.v1.Client method)
list_enabled_audit_devices() (hvac.api.system_backend.Audit method)
list_entities() (hvac.api.secrets_engines.Identity method)
list_entities_by_name() (hvac.api.secrets_engines.Identity method)
list_entity_aliases() (hvac.api.secrets_engines.Identity method)
list_group_aliases() (hvac.api.secrets_engines.Identity method)
list_groups() (hvac.api.auth_methods.Ldap method)
(hvac.api.auth_methods.Okta method)
(hvac.api.secrets_engines.Identity method)
list_groups_by_name() (hvac.api.secrets_engines.Identity method)
list_identity_whitelist() (hvac.api.auth_methods.Aws method)
list_keys() (hvac.api.secrets_engines.Transit method)
list_kubernetes_roles() (hvac.v1.Client method)
list_leases() (hvac.api.system_backend.Lease method)
list_mounted_secrets_engines() (hvac.api.system_backend.Mount method)
list_named_keys() (hvac.api.secrets_engines.Identity method)
list_namespaces() (hvac.api.system_backend.Namespace method)
list_policies() (hvac.api.system_backend.Policy method)
(hvac.v1.Client method)
list_role_secrets() (hvac.v1.Client method)
list_roles() (hvac.api.auth_methods.Aws method)
(hvac.api.auth_methods.Azure method)
(hvac.api.auth_methods.Gcp method)
(hvac.api.auth_methods.JWT method)
(hvac.api.auth_methods.Kubernetes method)
(hvac.api.secrets_engines.ActiveDirectory method)
(hvac.api.secrets_engines.Aws method)
(hvac.api.secrets_engines.Azure method)
(hvac.api.secrets_engines.Database method)
(hvac.api.secrets_engines.Identity method)
(hvac.api.secrets_engines.Pki method)
(hvac.api.secrets_engines.Transform method)
(hvac.v1.Client method)
list_rolesets() (hvac.api.secrets_engines.Gcp method)
list_secret_backends() (hvac.v1.Client method)
list_secrets() (hvac.api.secrets_engines.KvV1 method)
(hvac.api.secrets_engines.KvV2 method)
list_sts_roles() (hvac.api.auth_methods.Aws method)
list_templates() (hvac.api.secrets_engines.Transform method)
list_to_comma_delimited() (in module hvac.utils)
list_token_roles() (hvac.v1.Client method)
list_transformations() (hvac.api.secrets_engines.Transform method)
list_user() (hvac.api.auth_methods.Userpass method)
list_userpass() (hvac.v1.Client method)
list_users() (hvac.api.auth_methods.Ldap method)
(hvac.api.auth_methods.Okta method)
(hvac.api.auth_methods.Radius method)
list_vault_ec2_certificate_configurations() (hvac.v1.Client method)
login() (hvac.adapters.Adapter method)
(hvac.api.auth_methods.Azure method)
(hvac.api.auth_methods.Gcp method)
(hvac.api.auth_methods.Github method)
(hvac.api.auth_methods.Kubernetes method)
(hvac.api.auth_methods.Ldap method)
(hvac.api.auth_methods.Okta method)
(hvac.api.auth_methods.Radius method)
(hvac.api.auth_methods.Userpass method)
(hvac.v1.Client method)
logout() (hvac.v1.Client method)
lookup_entity() (hvac.api.secrets_engines.Identity method)
lookup_group() (hvac.api.secrets_engines.Identity method)
lookup_token() (hvac.v1.Client method)
M
map_team() (hvac.api.auth_methods.Github method)
map_user() (hvac.api.auth_methods.Github method)
merge_entities() (hvac.api.secrets_engines.Identity method)
Mfa (class in hvac.api.auth_methods)
module
hvac.adapters
hvac.api
hvac.api.auth_methods
hvac.api.secrets_engines
hvac.api.system_backend
hvac.aws_utils
hvac.exceptions
hvac.utils
hvac.v1
Mount (class in hvac.api.system_backend)
move_backend() (hvac.api.system_backend.Mount method)
N
Namespace (class in hvac.api.system_backend)
O
OIDC (class in hvac.api.auth_methods)
oidc_authorization_url_request() (hvac.api.auth_methods.JWT method)
oidc_callback() (hvac.api.auth_methods.JWT method)
Okta (class in hvac.api.auth_methods)
P
ParamValidationError
patch() (hvac.api.secrets_engines.KvV2 method)
Pki (class in hvac.api.secrets_engines)
place_role_tags_in_blacklist() (hvac.api.auth_methods.Aws method)
Policy (class in hvac.api.system_backend)
post() (hvac.adapters.Adapter method)
put() (hvac.adapters.Adapter method)
R
RabbitMQ (class in hvac.api.secrets_engines)
Radius (class in hvac.api.auth_methods)
Raft (class in hvac.api.system_backend)
raise_for_error() (in module hvac.utils)
RateLimitExceeded
RawAdapter (class in hvac.adapters)
read() (hvac.v1.Client method)
read_active_public_keys() (hvac.api.secrets_engines.Identity method)
read_alphabet() (hvac.api.secrets_engines.Transform method)
read_auth_method_tuning() (hvac.api.system_backend.Auth method)
read_backup_keys() (hvac.api.system_backend.Key method)
read_ca_certificate() (hvac.api.secrets_engines.Pki method)
read_ca_certificate_chain() (hvac.api.secrets_engines.Pki method)
read_certificate() (hvac.api.secrets_engines.Pki method)
read_certificate_configuration() (hvac.api.auth_methods.Aws method)
read_config() (hvac.api.auth_methods.Aws method)
(hvac.api.auth_methods.Azure method)
(hvac.api.auth_methods.Gcp method)
(hvac.api.auth_methods.JWT method)
(hvac.api.auth_methods.Kubernetes method)
(hvac.api.auth_methods.Okta method)
(hvac.api.secrets_engines.ActiveDirectory method)
(hvac.api.secrets_engines.Azure method)
(hvac.api.secrets_engines.Gcp method)
read_configuration() (hvac.api.auth_methods.Github method)
(hvac.api.auth_methods.Ldap method)
(hvac.api.auth_methods.Mfa method)
(hvac.api.auth_methods.Radius method)
(hvac.api.secrets_engines.KvV2 method)
read_connection() (hvac.api.secrets_engines.Database method)
read_crl() (hvac.api.secrets_engines.Pki method)
read_crl_configuration() (hvac.api.secrets_engines.Pki method)
read_duo_behavior_configuration() (hvac.api.auth_methods.Mfa method)
read_entity() (hvac.api.secrets_engines.Identity method)
read_entity_alias() (hvac.api.secrets_engines.Identity method)
read_entity_by_name() (hvac.api.secrets_engines.Identity method)
read_group() (hvac.api.auth_methods.Ldap method)
(hvac.api.auth_methods.Okta method)
(hvac.api.secrets_engines.Identity method)
read_group_alias() (hvac.api.secrets_engines.Identity method)
read_group_by_name() (hvac.api.secrets_engines.Identity method)
read_health_status() (hvac.api.system_backend.Health method)
read_identity_integration() (hvac.api.auth_methods.Aws method)
read_identity_whitelist() (hvac.api.auth_methods.Aws method)
read_identity_whitelist_tidy() (hvac.api.auth_methods.Aws method)
read_init_status() (hvac.api.system_backend.Init method)
read_key() (hvac.api.secrets_engines.Transit method)
read_leader_status() (hvac.api.system_backend.Leader method)
read_lease() (hvac.api.system_backend.Lease method)
(hvac.v1.Client method)
read_lease_config() (hvac.api.secrets_engines.Aws method)
read_mount_configuration() (hvac.api.system_backend.Mount method)
read_named_key() (hvac.api.secrets_engines.Identity method)
read_policy() (hvac.api.system_backend.Policy method)
read_raft_config() (hvac.api.system_backend.Raft method)
read_rekey_progress() (hvac.api.system_backend.Key method)
read_rekey_verify_progress() (hvac.api.system_backend.Key method)
read_role() (hvac.api.auth_methods.Aws method)
(hvac.api.auth_methods.Azure method)
(hvac.api.auth_methods.Gcp method)
(hvac.api.auth_methods.JWT method)
(hvac.api.auth_methods.Kubernetes method)
(hvac.api.secrets_engines.ActiveDirectory method)
(hvac.api.secrets_engines.Aws method)
(hvac.api.secrets_engines.Database method)
(hvac.api.secrets_engines.Identity method)
(hvac.api.secrets_engines.Pki method)
(hvac.api.secrets_engines.RabbitMQ method)
(hvac.api.secrets_engines.Transform method)
read_role_tag_blacklist() (hvac.api.auth_methods.Aws method)
read_role_tag_blacklist_tidy() (hvac.api.auth_methods.Aws method)
read_roleset() (hvac.api.secrets_engines.Gcp method)
read_root_generation_progress() (hvac.api.system_backend.Key method)
read_seal_status() (hvac.api.system_backend.Seal method)
read_secret() (hvac.api.secrets_engines.KvV1 method)
read_secret_metadata() (hvac.api.secrets_engines.KvV2 method)
read_secret_version() (hvac.api.secrets_engines.KvV2 method)
read_sts_role() (hvac.api.auth_methods.Aws method)
read_team_mapping() (hvac.api.auth_methods.Github method)
read_template() (hvac.api.secrets_engines.Transform method)
read_tokens_backend_configuration() (hvac.api.secrets_engines.Identity method)
read_transformation() (hvac.api.secrets_engines.Transform method)
read_urls() (hvac.api.secrets_engines.Pki method)
read_user() (hvac.api.auth_methods.Ldap method)
(hvac.api.auth_methods.Okta method)
(hvac.api.auth_methods.Radius method)
(hvac.api.auth_methods.Userpass method)
read_user_mapping() (hvac.api.auth_methods.Github method)
read_userpass() (hvac.v1.Client method)
read_well_known_configurations() (hvac.api.secrets_engines.Identity method)
register_group() (hvac.api.auth_methods.Okta method)
register_user() (hvac.api.auth_methods.Okta method)
(hvac.api.auth_methods.Radius method)
rekey() (hvac.api.system_backend.Key method)
(hvac.v1.Client method)
rekey_multi() (hvac.api.system_backend.Key method)
(hvac.v1.Client method)
rekey_status() (hvac.v1.Client property)
rekey_verify() (hvac.api.system_backend.Key method)
rekey_verify_multi() (hvac.api.system_backend.Key method)
remount_secret_backend() (hvac.v1.Client method)
remove_nones() (in module hvac.utils)
remove_raft_node() (hvac.api.system_backend.Raft method)
renew_lease() (hvac.api.system_backend.Lease method)
renew_secret() (hvac.v1.Client method)
renew_self_token() (hvac.v1.Client method)
renew_token() (hvac.v1.Client method)
Request (in module hvac.adapters)
request() (hvac.adapters.Adapter method)
(hvac.adapters.JSONAdapter method)
(hvac.adapters.RawAdapter method)
reset_connection() (hvac.api.secrets_engines.Database method)
resolve_path() (hvac.api.auth_methods.JWT method)
restore_key() (hvac.api.secrets_engines.Transit method)
restore_raft_snapshot() (hvac.api.system_backend.Raft method)
retrieve_mount_option() (hvac.api.system_backend.Mount method)
revoke_certificate() (hvac.api.secrets_engines.Pki method)
revoke_force() (hvac.api.system_backend.Lease method)
revoke_lease() (hvac.api.system_backend.Lease method)
revoke_prefix() (hvac.api.system_backend.Lease method)
revoke_secret() (hvac.v1.Client method)
revoke_secret_prefix() (hvac.v1.Client method)
revoke_self_token() (hvac.v1.Client method)
revoke_token() (hvac.v1.Client method)
revoke_token_prefix() (hvac.v1.Client method)
rewrap_data() (hvac.api.secrets_engines.Transit method)
rotate() (hvac.v1.Client method)
rotate_crl() (hvac.api.secrets_engines.Pki method)
rotate_encryption_key() (hvac.api.system_backend.Key method)
rotate_key() (hvac.api.secrets_engines.Transit method)
rotate_named_key() (hvac.api.secrets_engines.Identity method)
rotate_roleset_account() (hvac.api.secrets_engines.Gcp method)
rotate_roleset_account_key() (hvac.api.secrets_engines.Gcp method)
rotate_root_credentials() (hvac.api.secrets_engines.Database method)
rotate_root_iam_credentials() (hvac.api.secrets_engines.Aws method)
S
Seal (class in hvac.api.system_backend)
seal() (hvac.api.system_backend.Seal method)
(hvac.v1.Client method)
seal_status() (hvac.v1.Client property)
secrets() (hvac.v1.Client property)
SecretsEngines (class in hvac.api)
(class in hvac.api.secrets_engines)
session() (hvac.v1.Client property)
set_crl_configuration() (hvac.api.secrets_engines.Pki method)
set_policy() (hvac.v1.Client method)
set_role_id() (hvac.v1.Client method)
set_signed_intermediate() (hvac.api.secrets_engines.Pki method)
set_urls() (hvac.api.secrets_engines.Pki method)
sign_certificate() (hvac.api.secrets_engines.Pki method)
sign_data() (hvac.api.secrets_engines.Transit method)
sign_intermediate() (hvac.api.secrets_engines.Pki method)
sign_self_issued() (hvac.api.secrets_engines.Pki method)
sign_verbatim() (hvac.api.secrets_engines.Pki method)
SigV4Auth (class in hvac.aws_utils)
start_generate_root() (hvac.v1.Client method)
start_rekey() (hvac.api.system_backend.Key method)
(hvac.v1.Client method)
start_root_token_generation() (hvac.api.system_backend.Key method)
step_down() (hvac.api.system_backend.Leader method)
submit_ca_information() (hvac.api.secrets_engines.Pki method)
submit_unseal_key() (hvac.api.system_backend.Seal method)
submit_unseal_keys() (hvac.api.system_backend.Seal method)
sys() (hvac.v1.Client property)
SystemBackend (class in hvac.api)
(class in hvac.api.system_backend)
SystemBackendMixin (class in hvac.api.system_backend)
T
take_raft_snapshot() (hvac.api.system_backend.Raft method)
tidy() (hvac.api.secrets_engines.Pki method)
tidy_blacklist_tags() (hvac.api.auth_methods.Aws method)
tidy_identity_whitelist_entries() (hvac.api.auth_methods.Aws method)
token() (hvac.v1.Client property)
token_role() (hvac.v1.Client method)
Transform (class in hvac.api.secrets_engines)
Transit (class in hvac.api.secrets_engines)
transit_create_key() (hvac.v1.Client method)
transit_decrypt_data() (hvac.v1.Client method)
transit_delete_key() (hvac.v1.Client method)
transit_encrypt_data() (hvac.v1.Client method)
transit_export_key() (hvac.v1.Client method)
transit_generate_data_key() (hvac.v1.Client method)
transit_generate_hmac() (hvac.v1.Client method)
transit_generate_rand_bytes() (hvac.v1.Client method)
transit_hash_data() (hvac.v1.Client method)
transit_list_keys() (hvac.v1.Client method)
transit_read_key() (hvac.v1.Client method)
transit_rewrap_data() (hvac.v1.Client method)
transit_rotate_key() (hvac.v1.Client method)
transit_sign_data() (hvac.v1.Client method)
transit_update_key() (hvac.v1.Client method)
transit_verify_signed_data() (hvac.v1.Client method)
trim_key() (hvac.api.secrets_engines.Transit method)
tune_auth_backend() (hvac.v1.Client method)
tune_auth_method() (hvac.api.system_backend.Auth method)
tune_mount_configuration() (hvac.api.system_backend.Mount method)
tune_secret_backend() (hvac.v1.Client method)
U
Unauthorized
undelete_secret_versions() (hvac.api.secrets_engines.KvV2 method)
UnexpectedError
unimplemented_classes (hvac.api.auth_methods.AuthMethods attribute)
(hvac.api.AuthMethods attribute)
(hvac.api.secrets_engines.SecretsEngines attribute)
(hvac.api.SecretsEngines attribute)
(hvac.api.system_backend.SystemBackend attribute)
(hvac.api.SystemBackend attribute)
unimplemented_classes() (hvac.api.VaultApiCategory property)
unseal() (hvac.v1.Client method)
unseal_multi() (hvac.v1.Client method)
unseal_reset() (hvac.v1.Client method)
unwrap() (hvac.api.system_backend.Wrapping method)
(hvac.v1.Client method)
update_entity() (hvac.api.secrets_engines.Identity method)
update_entity_alias() (hvac.api.secrets_engines.Identity method)
update_group() (hvac.api.secrets_engines.Identity method)
update_group_alias() (hvac.api.secrets_engines.Identity method)
update_key_configuration() (hvac.api.secrets_engines.Transit method)
update_metadata() (hvac.api.secrets_engines.KvV2 method)
update_password_on_user() (hvac.api.auth_methods.Userpass method)
update_userpass_password() (hvac.v1.Client method)
update_userpass_policies() (hvac.v1.Client method)
url() (hvac.v1.Client property)
urljoin() (hvac.adapters.Adapter static method)
(hvac.v1.Client static method)
Userpass (class in hvac.api.auth_methods)
V
v1() (hvac.api.secrets_engines.Kv property)
v2() (hvac.api.secrets_engines.Kv property)
validate_list_of_strings_param() (in module hvac.utils)
validate_member_id_params_for_group_type() (hvac.api.secrets_engines.Identity static method)
validate_pem_format() (in module hvac.utils)
VaultApiBase (class in hvac.api)
VaultApiCategory (class in hvac.api)
VaultDown
VaultError
VaultNotInitialized
verify_signed_data() (hvac.api.secrets_engines.Transit method)
W
Wrapping (class in hvac.api.system_backend)
write() (hvac.v1.Client method)
Read the Docs
v: v0.10.5
Versions
master
latest
stable
v0.10.5
v0.10.4
v0.10.3
v0.10.2
v0.10.1
v0.10.0
v0.9.6
v0.9.5
v0.9.4
v0.9.3
v0.9.2
v0.9.1
v0.9.0
v0.8.2
v0.8.1
v0.8.0
v0.7.2
v0.7.1
v0.7.0
v0.6.4
v0.6.3
v0.6.2
Downloads
On Read the Docs
Project Home
Builds