Archived documentation version for the DevNet Expert exam. Learn more at DevNet Academy | Docs Home
hvac
v0.11.2
  • 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
      • 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
        • 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
      • 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.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
  • Edit on GitHub

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

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