hvac
2.4.0
  • 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
      • Active Directory
        • Configure AD Secrets Secrets Engine
        • Read Config
        • Create or Update Role
        • Read Role
        • List Roles
        • Delete Role
        • Generate Credentials
      • 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
      • Database
        • Enable Database Secrets Engine
        • Configuration
        • Read Configuration
        • List Connections
        • Delete Connection
        • Reset Connection
        • Create Role
        • Read A Role
        • List All The Roles
        • Delete A Role
        • Rotate Root Credentials
        • Generate Credentials
        • Get Static Credentials
        • Create Static Role
        • Read Static Role
        • List Static Roles
        • Rotate Static Role Credentials
      • GCP
        • Configure
        • Rotate Root Credentials
        • 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
        • Create Or Update Static Account
        • Rotate Static Account Key
        • Read Static Account
        • List Static Accounts
        • Delete Static Account
        • Generate Static Account OAuth2 Access Token
        • Generate Static Account Service Account Key
        • Create Or Update Impersonated Account
        • Read Impersonated Account
        • List Impersonated Accounts
        • Delete Impersonated Account
        • Generate Impersonated Account OAuth2 Access Token
      • Identity
        • Entity
        • Entity Alias
        • Group
        • Group Alias
        • Lookup
        • Tokens
      • LDAP
        • Configure LDAP Secrets Secrets Engine
        • Read Config
        • Rotate Root
        • Create or Update Static Role
        • Read Static Role
        • List Static Roles
        • Delete Static Role
        • Generate Static Credentials
        • Rotate Static Credentials
      • 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
        • Read Issuer
        • List Issuers
        • Update Issuer
        • Revoke Issuer
        • Delete Issuer
      • 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
        • Create Or Update FPE Transformation
        • Create Or Update Masking Transformation
        • Create Or Update Tokenization Transformation
        • Create Or Update Tokenization Store
        • Encode
        • Validate Token
        • Check Tokenization
        • Retrieve Token Metadata
        • Snapshot Tokenization State
        • Restore Tokenization State
        • Export Decoded Tokenization State
        • Rotate Tokenization Key
        • Update Tokenization Key Config
        • List Tokenization Key Configuration
        • Read Tokenization Key Configuration
        • Trim Tokenization Key Version
      • 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
        • Enabling
        • Authentication
        • Create or Update AppRole
        • Read Role ID
        • Generate Secret ID
      • 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
      • Legacy MFA
        • Configure Legacy MFA Auth Method Settings
        • Reading the Legacy MFA Auth Method Configuration
        • Configure Duo LegacyMFA Type Access Credentials
        • Configure Duo Legacy MFA Type Behavior
        • Read Duo Legacy 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
      • Userpass
        • Authentication
      • 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
      • Policies
        • Read ACL Policy
        • Create or Update ACL Policy
        • List ACL Policies
        • Delete ACL Policy
        • Read RGP Policy
        • Create or Update RGP Policy
        • List RGP Policies
        • Delete RGP Policy
        • Read EGP Policy
        • Create or Update EGP Policy
        • List EGP Policies
        • Delete EGP Policy
      • Policy
        • Manipulate policies
        • List Policies
        • Read Policy
        • Create Or Update Policy
        • Delete Policy
      • Quota
        • Read Quota
        • Create or Update Quota
        • List Quotas
        • Delete Quota
      • Raft
        • Join Raft Cluster
        • Read Raft Configuration
        • Remove Raft Node
        • Read Raft Auto-Snapshot Status
        • Read Raft Auto-Snapshot Configuration
        • List Raft Auto-Snapshot Configurations
        • Create or Update Raft Auto-Snapshot Configuration
        • Delete Raft Auto-Snapshot Configuration
      • Seal
        • Seal Status
        • Is Sealed
        • Read Seal Status
        • Seal
        • Submit Unseal Key
        • Submit Unseal Keys
      • Wrapping
        • Unwrap
    • Initialize and seal/unseal
  • Advanced Usage
    • Making Use of Private CA
    • Custom Requests / HTTP Adapter
      • Custom Adapters
      • Retrying Failed Requests
        • Allowed methods
    • Vault Agent Unix Socket Listener
  • User-Contributed Usage
    • Support for HTTP/2 onward with Niquests
      • Session
      • Security
      • Multiplexing
  • Source Reference
    • hvac.v1
      • Client
        • Client.__init__()
        • Client.adapter
        • Client.allow_redirects
        • Client.auth
        • Client.auth_cubbyhole()
        • Client.delete()
        • Client.generate_root_status
        • Client.get_policy()
        • Client.ha_status
        • Client.is_authenticated()
        • Client.key_status
        • Client.list()
        • Client.login()
        • Client.logout()
        • Client.lookup_token()
        • Client.read()
        • Client.rekey_status
        • Client.renew_token()
        • Client.revoke_token()
        • Client.seal_status
        • Client.secrets
        • Client.session
        • Client.sys
        • Client.token
        • Client.url
        • Client.write()
        • Client.write_data()
    • hvac.api
      • AuthMethods
        • AuthMethods.implemented_classes
        • AuthMethods.unimplemented_classes
      • SecretsEngines
        • SecretsEngines.implemented_classes
        • SecretsEngines.unimplemented_classes
      • SystemBackend
        • SystemBackend.implemented_classes
        • SystemBackend.unimplemented_classes
      • VaultApiBase
        • VaultApiBase.__init__()
      • VaultApiCategory
        • VaultApiCategory.__init__()
        • VaultApiCategory.adapter
        • VaultApiCategory.get_private_attr_name()
        • VaultApiCategory.implemented_classes
        • VaultApiCategory.unimplemented_classes
    • hvac.api.auth_methods
      • AppRole
        • AppRole.create_custom_secret_id()
        • AppRole.create_or_update_approle()
        • AppRole.delete_role()
        • AppRole.destroy_secret_id()
        • AppRole.destroy_secret_id_accessor()
        • AppRole.generate_secret_id()
        • AppRole.list_roles()
        • AppRole.list_secret_id_accessors()
        • AppRole.login()
        • AppRole.read_role()
        • AppRole.read_role_id()
        • AppRole.read_secret_id()
        • AppRole.read_secret_id_accessor()
        • AppRole.update_role_id()
      • AuthMethods
        • AuthMethods.implemented_classes
        • AuthMethods.unimplemented_classes
      • Aws
        • Aws.configure()
        • Aws.configure_identity_integration()
        • Aws.configure_identity_whitelist_tidy()
        • Aws.configure_role_tag_blacklist_tidy()
        • Aws.create_certificate_configuration()
        • Aws.create_role()
        • Aws.create_role_tags()
        • Aws.create_sts_role()
        • Aws.delete_blacklist_tags()
        • Aws.delete_certificate_configuration()
        • Aws.delete_config()
        • Aws.delete_identity_whitelist_entries()
        • Aws.delete_identity_whitelist_tidy()
        • Aws.delete_role()
        • Aws.delete_role_tag_blacklist_tidy()
        • Aws.delete_sts_role()
        • Aws.ec2_login()
        • Aws.iam_login()
        • Aws.list_blacklist_tags()
        • Aws.list_certificate_configurations()
        • Aws.list_identity_whitelist()
        • Aws.list_roles()
        • Aws.list_sts_roles()
        • Aws.place_role_tags_in_blacklist()
        • Aws.read_certificate_configuration()
        • Aws.read_config()
        • Aws.read_identity_integration()
        • Aws.read_identity_whitelist()
        • Aws.read_identity_whitelist_tidy()
        • Aws.read_role()
        • Aws.read_role_tag_blacklist()
        • Aws.read_role_tag_blacklist_tidy()
        • Aws.read_sts_role()
        • Aws.tidy_blacklist_tags()
        • Aws.tidy_identity_whitelist_entries()
      • Azure
        • Azure.configure()
        • Azure.create_role()
        • Azure.delete_config()
        • Azure.delete_role()
        • Azure.list_roles()
        • Azure.login()
        • Azure.read_config()
        • Azure.read_role()
      • Cert
        • Cert.CertificateAuthError
        • Cert.configure_tls_certificate()
        • Cert.create_ca_certificate_role()
        • Cert.delete_certificate_role()
        • Cert.list_certificate_roles()
        • Cert.login()
        • Cert.read_ca_certificate_role()
      • Gcp
        • Gcp.configure()
        • Gcp.create_role()
        • Gcp.delete_config()
        • Gcp.delete_role()
        • Gcp.edit_labels_on_gce_role()
        • Gcp.edit_service_accounts_on_iam_role()
        • Gcp.list_roles()
        • Gcp.login()
        • Gcp.read_config()
        • Gcp.read_role()
      • Github
        • Github.configure()
        • Github.login()
        • Github.map_team()
        • Github.map_user()
        • Github.read_configuration()
        • Github.read_team_mapping()
        • Github.read_user_mapping()
      • JWT
        • JWT.DEFAULT_PATH
        • JWT.configure()
        • JWT.create_role()
        • JWT.delete_role()
        • JWT.jwt_login()
        • JWT.list_roles()
        • JWT.oidc_authorization_url_request()
        • JWT.oidc_callback()
        • JWT.read_config()
        • JWT.read_role()
        • JWT.resolve_path()
      • Kubernetes
        • Kubernetes.configure()
        • Kubernetes.create_role()
        • Kubernetes.delete_role()
        • Kubernetes.list_roles()
        • Kubernetes.login()
        • Kubernetes.read_config()
        • Kubernetes.read_role()
      • Ldap
        • Ldap.configure()
        • Ldap.create_or_update_group()
        • Ldap.create_or_update_user()
        • Ldap.delete_group()
        • Ldap.delete_user()
        • Ldap.list_groups()
        • Ldap.list_users()
        • Ldap.login()
        • Ldap.read_configuration()
        • Ldap.read_group()
        • Ldap.read_user()
      • LegacyMfa
        • LegacyMfa.configure()
        • LegacyMfa.configure_duo_access()
        • LegacyMfa.configure_duo_behavior()
        • LegacyMfa.read_configuration()
        • LegacyMfa.read_duo_behavior_configuration()
      • OIDC
        • OIDC.DEFAULT_PATH
        • OIDC.create_role()
      • Okta
        • Okta.configure()
        • Okta.delete_group()
        • Okta.delete_user()
        • Okta.list_groups()
        • Okta.list_users()
        • Okta.login()
        • Okta.read_config()
        • Okta.read_group()
        • Okta.read_user()
        • Okta.register_group()
        • Okta.register_user()
      • Radius
        • Radius.configure()
        • Radius.delete_user()
        • Radius.list_users()
        • Radius.login()
        • Radius.read_configuration()
        • Radius.read_user()
        • Radius.register_user()
      • Token
        • Token.create()
        • Token.create_or_update_role()
        • Token.create_orphan()
        • Token.delete_role()
        • Token.list_accessors()
        • Token.list_roles()
        • Token.lookup()
        • Token.lookup_accessor()
        • Token.lookup_self()
        • Token.read_role()
        • Token.renew()
        • Token.renew_accessor()
        • Token.renew_self()
        • Token.revoke()
        • Token.revoke_accessor()
        • Token.revoke_and_orphan_children()
        • Token.revoke_self()
        • Token.tidy()
      • Userpass
        • Userpass.create_or_update_user()
        • Userpass.delete_user()
        • Userpass.list_user()
        • Userpass.login()
        • Userpass.read_user()
        • Userpass.update_password_on_user()
    • hvac.api.secrets_engines
      • ActiveDirectory
        • ActiveDirectory.configure()
        • ActiveDirectory.create_or_update_role()
        • ActiveDirectory.delete_role()
        • ActiveDirectory.generate_credentials()
        • ActiveDirectory.list_roles()
        • ActiveDirectory.read_config()
        • ActiveDirectory.read_role()
      • Aws
        • Aws.configure_lease()
        • Aws.configure_root_iam_credentials()
        • Aws.create_or_update_role()
        • Aws.delete_role()
        • Aws.generate_credentials()
        • Aws.list_roles()
        • Aws.read_lease_config()
        • Aws.read_role()
        • Aws.rotate_root_iam_credentials()
      • Azure
        • Azure.configure()
        • Azure.create_or_update_role()
        • Azure.delete_config()
        • Azure.generate_credentials()
        • Azure.list_roles()
        • Azure.read_config()
      • Database
        • Database.configure()
        • Database.create_role()
        • Database.create_static_role()
        • Database.delete_connection()
        • Database.delete_role()
        • Database.delete_static_role()
        • Database.generate_credentials()
        • Database.get_static_credentials()
        • Database.list_connections()
        • Database.list_roles()
        • Database.list_static_roles()
        • Database.read_connection()
        • Database.read_role()
        • Database.read_static_role()
        • Database.reset_connection()
        • Database.rotate_root_credentials()
        • Database.rotate_static_role_credentials()
      • Gcp
        • Gcp.configure()
        • Gcp.create_or_update_impersonated_account()
        • Gcp.create_or_update_roleset()
        • Gcp.create_or_update_static_account()
        • Gcp.delete_impersonated_account()
        • Gcp.delete_roleset()
        • Gcp.delete_static_account()
        • Gcp.generate_impersonated_account_oauth2_access_token()
        • Gcp.generate_oauth2_access_token()
        • Gcp.generate_service_account_key()
        • Gcp.generate_static_account_oauth2_access_token()
        • Gcp.generate_static_account_service_account_key()
        • Gcp.list_impersonated_accounts()
        • Gcp.list_rolesets()
        • Gcp.list_static_accounts()
        • Gcp.read_config()
        • Gcp.read_impersonated_account()
        • Gcp.read_roleset()
        • Gcp.read_static_account()
        • Gcp.rotate_roleset_account()
        • Gcp.rotate_roleset_account_key()
        • Gcp.rotate_root_credentials()
        • Gcp.rotate_static_account_key()
      • Identity
        • Identity.configure_tokens_backend()
        • Identity.create_named_key()
        • Identity.create_or_update_entity()
        • Identity.create_or_update_entity_alias()
        • Identity.create_or_update_entity_by_name()
        • Identity.create_or_update_group()
        • Identity.create_or_update_group_alias()
        • Identity.create_or_update_group_by_name()
        • Identity.create_or_update_role()
        • Identity.delete_entity()
        • Identity.delete_entity_alias()
        • Identity.delete_entity_by_name()
        • Identity.delete_group()
        • Identity.delete_group_alias()
        • Identity.delete_group_by_name()
        • Identity.delete_named_key()
        • Identity.delete_role()
        • Identity.generate_signed_id_token()
        • Identity.introspect_signed_id_token()
        • Identity.list_entities()
        • Identity.list_entities_by_name()
        • Identity.list_entity_aliases()
        • Identity.list_group_aliases()
        • Identity.list_groups()
        • Identity.list_groups_by_name()
        • Identity.list_named_keys()
        • Identity.list_roles()
        • Identity.lookup_entity()
        • Identity.lookup_group()
        • Identity.merge_entities()
        • Identity.read_active_public_keys()
        • Identity.read_entity()
        • Identity.read_entity_alias()
        • Identity.read_entity_by_name()
        • Identity.read_group()
        • Identity.read_group_alias()
        • Identity.read_group_by_name()
        • Identity.read_named_key()
        • Identity.read_role()
        • Identity.read_tokens_backend_configuration()
        • Identity.read_well_known_configurations()
        • Identity.rotate_named_key()
        • Identity.update_entity()
        • Identity.update_entity_alias()
        • Identity.update_group()
        • Identity.update_group_alias()
        • Identity.validate_member_id_params_for_group_type()
      • Kv
        • Kv.__init__()
        • Kv.allowed_kv_versions
        • Kv.default_kv_version
        • Kv.v1
        • Kv.v2
      • KvV1
        • KvV1.create_or_update_secret()
        • KvV1.delete_secret()
        • KvV1.list_secrets()
        • KvV1.read_secret()
      • KvV2
        • KvV2.configure()
        • KvV2.create_or_update_secret()
        • KvV2.delete_latest_version_of_secret()
        • KvV2.delete_metadata_and_all_versions()
        • KvV2.delete_secret_versions()
        • KvV2.destroy_secret_versions()
        • KvV2.list_secrets()
        • KvV2.patch()
        • KvV2.read_configuration()
        • KvV2.read_secret()
        • KvV2.read_secret_metadata()
        • KvV2.read_secret_version()
        • KvV2.undelete_secret_versions()
        • KvV2.update_metadata()
      • Ldap
        • Ldap.configure()
        • Ldap.create_or_update_static_role()
        • Ldap.delete_static_role()
        • Ldap.generate_static_credentials()
        • Ldap.list_static_roles()
        • Ldap.read_config()
        • Ldap.read_static_role()
        • Ldap.rotate_root()
        • Ldap.rotate_static_credentials()
      • Pki
        • Pki.create_or_update_role()
        • Pki.delete_issuer()
        • Pki.delete_role()
        • Pki.delete_root()
        • Pki.generate_certificate()
        • Pki.generate_intermediate()
        • Pki.generate_root()
        • Pki.list_certificates()
        • Pki.list_issuers()
        • Pki.list_roles()
        • Pki.read_ca_certificate()
        • Pki.read_ca_certificate_chain()
        • Pki.read_certificate()
        • Pki.read_crl()
        • Pki.read_crl_configuration()
        • Pki.read_issuer()
        • Pki.read_role()
        • Pki.read_urls()
        • Pki.revoke_certificate()
        • Pki.revoke_issuer()
        • Pki.rotate_crl()
        • Pki.set_crl_configuration()
        • Pki.set_signed_intermediate()
        • Pki.set_urls()
        • Pki.sign_certificate()
        • Pki.sign_intermediate()
        • Pki.sign_self_issued()
        • Pki.sign_verbatim()
        • Pki.submit_ca_information()
        • Pki.tidy()
        • Pki.update_issuer()
      • RabbitMQ
        • RabbitMQ.configure()
        • RabbitMQ.configure_lease()
        • RabbitMQ.create_role()
        • RabbitMQ.delete_role()
        • RabbitMQ.generate_credentials()
        • RabbitMQ.read_role()
      • SecretsEngines
        • SecretsEngines.implemented_classes
        • SecretsEngines.unimplemented_classes
      • Ssh
        • Ssh.configure_zeroaddress_roles()
        • Ssh.create_or_update_key()
        • Ssh.create_role()
        • Ssh.delete_ca_information()
        • Ssh.delete_key()
        • Ssh.delete_role()
        • Ssh.delete_zeroaddress_role()
        • Ssh.generate_ssh_credentials()
        • Ssh.list_roles()
        • Ssh.list_roles_by_ip()
        • Ssh.list_zeroaddress_roles()
        • Ssh.read_public_key()
        • Ssh.read_role()
        • Ssh.sign_ssh_key()
        • Ssh.submit_ca_information()
        • Ssh.verify_ssh_otp()
      • Transform
        • Transform.check_tokenization()
        • Transform.create_or_update_alphabet()
        • Transform.create_or_update_fpe_transformation()
        • Transform.create_or_update_masking_transformation()
        • Transform.create_or_update_role()
        • Transform.create_or_update_template()
        • Transform.create_or_update_tokenization_store()
        • Transform.create_or_update_tokenization_transformation()
        • Transform.create_or_update_transformation()
        • Transform.decode()
        • Transform.delete_alphabet()
        • Transform.delete_role()
        • Transform.delete_template()
        • Transform.delete_transformation()
        • Transform.encode()
        • Transform.export_decoded_tokenization_state()
        • Transform.list_alphabets()
        • Transform.list_roles()
        • Transform.list_templates()
        • Transform.list_tokenization_key_configuration()
        • Transform.list_transformations()
        • Transform.read_alphabet()
        • Transform.read_role()
        • Transform.read_template()
        • Transform.read_tokenization_key_configuration()
        • Transform.read_transformation()
        • Transform.restore_tokenization_state()
        • Transform.retrieve_token_metadata()
        • Transform.rotate_tokenization_key()
        • Transform.snapshot_tokenization_state()
        • Transform.trim_tokenization_key_version()
        • Transform.update_tokenization_key_config()
        • Transform.validate_token()
      • Transit
        • Transit.backup_key()
        • Transit.create_key()
        • Transit.decrypt_data()
        • Transit.delete_key()
        • Transit.encrypt_data()
        • Transit.export_key()
        • Transit.generate_data_key()
        • Transit.generate_hmac()
        • Transit.generate_random_bytes()
        • Transit.hash_data()
        • Transit.list_keys()
        • Transit.read_key()
        • Transit.restore_key()
        • Transit.rewrap_data()
        • Transit.rotate_key()
        • Transit.sign_data()
        • Transit.trim_key()
        • Transit.update_key_configuration()
        • Transit.verify_signed_data()
    • hvac.api.system_backend
      • Audit
        • Audit.calculate_hash()
        • Audit.disable_audit_device()
        • Audit.enable_audit_device()
        • Audit.list_enabled_audit_devices()
      • Auth
        • Auth.disable_auth_method()
        • Auth.enable_auth_method()
        • Auth.list_auth_methods()
        • Auth.read_auth_method_tuning()
        • Auth.tune_auth_method()
      • Capabilities
        • Capabilities.get_capabilities()
      • Health
        • Health.read_health_status()
      • Init
        • Init.initialize()
        • Init.is_initialized()
        • Init.read_init_status()
      • Key
        • Key.cancel_rekey()
        • Key.cancel_rekey_verify()
        • Key.cancel_root_generation()
        • Key.generate_root()
        • Key.get_encryption_key_status()
        • Key.read_backup_keys()
        • Key.read_rekey_progress()
        • Key.read_rekey_verify_progress()
        • Key.read_root_generation_progress()
        • Key.rekey()
        • Key.rekey_multi()
        • Key.rekey_verify()
        • Key.rekey_verify_multi()
        • Key.rotate_encryption_key()
        • Key.start_rekey()
        • Key.start_root_token_generation()
      • Leader
        • Leader.read_leader_status()
        • Leader.step_down()
      • Lease
        • Lease.list_leases()
        • Lease.read_lease()
        • Lease.renew_lease()
        • Lease.revoke_force()
        • Lease.revoke_lease()
        • Lease.revoke_prefix()
      • Mount
        • Mount.disable_secrets_engine()
        • Mount.enable_secrets_engine()
        • Mount.list_mounted_secrets_engines()
        • Mount.move_backend()
        • Mount.read_mount_configuration()
        • Mount.retrieve_mount_option()
        • Mount.tune_mount_configuration()
      • Namespace
        • Namespace.create_namespace()
        • Namespace.delete_namespace()
        • Namespace.list_namespaces()
      • Policies
        • Policies.create_or_update_acl_policy()
        • Policies.create_or_update_egp_policy()
        • Policies.create_or_update_rgp_policy()
        • Policies.delete_acl_policy()
        • Policies.delete_egp_policy()
        • Policies.delete_rgp_policy()
        • Policies.list_acl_policies()
        • Policies.list_egp_policies()
        • Policies.list_rgp_policies()
        • Policies.read_acl_policy()
        • Policies.read_egp_policy()
        • Policies.read_rgp_policy()
      • Policy
        • Policy.create_or_update_policy()
        • Policy.delete_policy()
        • Policy.list_policies()
        • Policy.read_policy()
      • Quota
        • Quota.create_or_update_quota()
        • Quota.delete_quota()
        • Quota.list_quotas()
        • Quota.read_quota()
      • Raft
        • Raft.create_or_update_raft_auto_snapshot_config()
        • Raft.delete_raft_auto_snapshot_config()
        • Raft.force_restore_raft_snapshot()
        • Raft.join_raft_cluster()
        • Raft.list_raft_auto_snapshot_configs()
        • Raft.read_raft_auto_snapshot_config()
        • Raft.read_raft_auto_snapshot_status()
        • Raft.read_raft_config()
        • Raft.remove_raft_node()
        • Raft.restore_raft_snapshot()
        • Raft.take_raft_snapshot()
      • Seal
        • Seal.is_sealed()
        • Seal.read_seal_status()
        • Seal.seal()
        • Seal.submit_unseal_key()
        • Seal.submit_unseal_keys()
      • SystemBackend
        • SystemBackend.implemented_classes
        • SystemBackend.unimplemented_classes
      • SystemBackendMixin
      • Wrapping
        • Wrapping.unwrap()
        • Wrapping.wrap()
    • hvac.utils
      • aliased_parameter()
      • comma_delimited_to_list()
      • deprecated_method()
      • format_url()
      • generate_method_deprecation_message()
      • generate_parameter_deprecation_message()
      • generate_property_deprecation_message()
      • get_token_from_env()
      • getattr_with_deprecated_properties()
      • list_to_comma_delimited()
      • raise_for_error()
      • remove_nones()
      • validate_list_of_strings_param()
      • validate_pem_format()
    • hvac.aws_utils
      • SigV4Auth
        • SigV4Auth.__init__()
        • SigV4Auth.add_auth()
      • generate_sigv4_auth_request()
    • hvac.adapters
      • Adapter
        • Adapter.__init__()
        • Adapter.close()
        • Adapter.delete()
        • Adapter.from_adapter()
        • Adapter.get()
        • Adapter.get_login_token()
        • Adapter.head()
        • Adapter.list()
        • Adapter.login()
        • Adapter.post()
        • Adapter.put()
        • Adapter.request()
        • Adapter.urljoin()
      • JSONAdapter
        • JSONAdapter.get_login_token()
        • JSONAdapter.request()
      • RawAdapter
        • RawAdapter.get_login_token()
        • RawAdapter.request()
      • Request
    • hvac.exceptions
      • BadGateway
      • Forbidden
      • InternalServerError
      • InvalidPath
      • InvalidRequest
      • ParamValidationError
      • PreconditionFailed
      • RateLimitExceeded
      • Unauthorized
      • UnexpectedError
      • UnsupportedOperation
      • VaultDown
      • VaultError
        • VaultError.__init__()
        • VaultError.from_status()
      • VaultNotInitialized
  • Contributing
    • Typical Development Environment Setup
    • Testing
    • Updating Requirements
    • Documentation
      • Adding new dependencies
      • Adding New Documentation Files
      • Testing Docs
      • Examples
    • Backwards Compatibility Breaking Changes
    • Creating / Publishing Releases
      • Preparing the release branch
      • Updating the version
      • Updating the changelog
        • Handling announcements and deprecations
      • Opening the release PR
      • Tag and release
  • Changelog
    • 2.4.0
      • 🚀 Features
      • 📚 Documentation
      • 🧰 Miscellaneous
    • 2.3.0
      • 🚀 Features
      • 🧰 Miscellaneous
    • 2.2.0
      • 📢 Deprecations / Announcements
      • 🚀 Features
      • 🧰 Miscellaneous
    • 2.1.0
      • 🚀 Features
      • 🐛 Bug Fixes
      • 📚 Documentation
      • 🧰 Miscellaneous
    • 2.0.0
      • 💥 Breaking Changes
      • 📢 Deprecations / Announcements
      • 🚀 Features
      • 🐛 Bug Fixes
      • 📚 Documentation
      • 🧰 Miscellaneous
    • 1.2.1
      • 🐛 Bug Fixes
    • 1.2.0
      • 📢 Deprecations / Announcements
      • 🚀 Features
      • 🐛 Bug Fixes
      • 📚 Documentation
      • 🧰 Miscellaneous
    • 1.1.1
      • 🐛 Bug Fixes
    • 1.1.0
      • 📢 Deprecations / Announcements
      • 🚀 Features
      • 🐛 Bug Fixes
      • 📚 Documentation
      • 🧰 Miscellaneous
    • 1.0.2
    • 1.0.1
      • 🐛 Bug Fixes
      • 📚 Documentation
    • 1.0.0
      • 💥 Breaking Changes
      • 🚀 Features
      • 🐛 Bug Fixes
      • 📚 Documentation
      • 🧰 Miscellaneous
    • 0.11.2 (September 23rd, 2021)
      • 🐛 Bug Fixes
    • 0.11.1 (September 22nd, 2021)
      • 💥 Breaking Changes
      • 🚀 Features
      • 🐛 Bug Fixes
    • 0.11.0 (July 12th, 2021)
      • 💥 Breaking Changes
      • 🚀 Features
      • 🐛 Bug Fixes
      • 🧰 Miscellaneous
    • 0.10.14 (May 21st, 2021)
      • 🐛 Bug Fixes
    • 0.10.13 (May 20th, 2021)
      • 🐛 Bug Fixes
    • 0.10.12 (May 19th, 2021)
      • 🚀 Features
    • 0.10.11 (May 7th, 2021)
      • 🚀 Features
      • 🧰 Miscellaneous
    • 0.10.10 (April 29th, 2021)
      • 🚀 Features
      • 🧰 Miscellaneous
    • 0.10.9 (April 2nd, 2021)
      • 🐛 Bug Fixes
      • 📚 Documentation
    • 0.10.8 (February 8th, 2021)
      • 🚀 Features
    • 0.10.7 (February 1st, 2021)
      • 🚀 Features
      • 🧰 Miscellaneous
    • 0.10.6 (December 14th, 2020)
      • 🚀 Features
      • 🐛 Bug Fixes
      • 🧰 Miscellaneous
    • 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
  • Search

© Copyright 2018-2020, Ian Unruh, Jeffrey Hogan.

Built with Sphinx using a theme provided by Read the Docs.