hvac
v0.8.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
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
Identity
Entity
Entity Alias
Group
Group Alias
Lookup
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
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
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
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
List Enabled Audit Devices
Enable Audit Device
Disable Audit Device
Calculate Hash
Auth
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 Backup Keys
Leader
Read Leader Status
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
Policy
Manipulate policies
List Policies
Read Policy
Create Or Update Policy
Delete Policy
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
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
Testing
Updating Requirements
Documentation
Examples
Backwards Compatibility Breaking Changes
Package Publishing Checklist
Changelog
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
Docs
»
Usage
»
Auth Methods
»
Approle
Edit on GitHub
Approle
¶
Authentication
¶
client
.
auth_approle
(
'MY_ROLE_ID'
,
'MY_SECRET_ID'
)
Read the Docs
v: v0.8.2
Versions
latest
stable
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
master
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.