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()
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
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()
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()
ActiveDirectory
ActiveDirectory.configure()
ActiveDirectory.create_or_update_role()
ActiveDirectory.delete_role()
ActiveDirectory.generate_credentials()
ActiveDirectory.list_roles()
ActiveDirectory.read_config()
ActiveDirectory.read_role()
Aws.configure_lease()
Aws.configure_root_iam_credentials()
Aws.create_or_update_role()
Aws.generate_credentials()
Aws.read_lease_config()
Aws.rotate_root_iam_credentials()
Azure.create_or_update_role()
Azure.generate_credentials()
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.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_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()
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()
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()
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.force_restore_raft_snapshot()
Raft.join_raft_cluster()
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()
SystemBackendMixin
Wrapping
Wrapping.unwrap()
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()
SigV4Auth
SigV4Auth.__init__()
SigV4Auth.add_auth()
generate_sigv4_auth_request()
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
BadGateway
Forbidden
InternalServerError
InvalidPath
InvalidRequest
ParamValidationError
RateLimitExceeded
Unauthorized
UnexpectedError
VaultDown
VaultError
VaultError.__init__()
VaultError.from_status()
VaultNotInitialized
Warning
The use cases presented in this section are not directly supported by hvac maintainers.
hvac