hvac の API リファレンス

hvac (hvac/hvac) の公開 API 116 件 —— クラス 38、関数 1、メソッド 77。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: hvac/hvac

種別	件数
クラス	38
関数	1
メソッド	77

API 一覧

methodhvac.adapters.Adapter.close()

Close the underlying Requests session.

methodhvac.adapters.Adapter.delete(url, **kwargs)

Performs a DELETE request.

methodhvac.adapters.Adapter.get(url, **kwargs)

Performs a GET request.

methodhvac.adapters.Adapter.head(url, **kwargs)

Performs a HEAD request.

methodhvac.adapters.Adapter.list(url, **kwargs)

Performs a LIST request.

methodhvac.adapters.Adapter.login(url, use_token=True, **kwargs)

Perform a login request.

methodhvac.adapters.Adapter.post(url, **kwargs)

Performs a POST request.

methodhvac.adapters.Adapter.put(url, **kwargs)

Performs a PUT request.

methodhvac.adapters.Adapter.request(method, url, headers=None, raise_exception=True, **kwargs)

Main method for routing HTTP requests to the configured Vault base_uri.

methodhvac.adapters.Adapter.urljoin(*args)

Joins given arguments into a url.

classhvac.adapters.JSONAdapter

The JSONAdapter adapter class.

classhvac.adapters.RawAdapter

The RawAdapter adapter class.

classhvac.api.auth_methods.AuthMethods

Auth Methods.

classhvac.api.auth_methods.approle.AppRole

USERPASS Auth Method (API).

classhvac.api.auth_methods.aws.Aws

AWS Auth Method (API).

classhvac.api.auth_methods.azure.Azure

Azure Auth Method (API).

classhvac.api.auth_methods.cert.Cert

Cert Auth Method (API).

classhvac.api.auth_methods.gcp.Gcp

Google Cloud Auth Method (API).

classhvac.api.auth_methods.github.Github

GitHub Auth Method (API).

methodhvac.api.auth_methods.jwt.JWT.jwt_login(role, jwt, use_token=True, path=None)

Fetch a token.

methodhvac.api.auth_methods.jwt.JWT.read_config(path=None)

Read the previously configured config.

classhvac.api.auth_methods.kubernetes.Kubernetes

Kubernetes Auth Method (API).

methodhvac.api.auth_methods.kubernetes.Kubernetes.login(role, jwt, use_token=True, mount_point=DEFAULT_MOUNT_POINT)

Fetch a token.

classhvac.api.auth_methods.ldap.Ldap

LDAP Auth Method (API).

classhvac.api.auth_methods.legacy_mfa.LegacyMfa

Multi-factor authentication Auth Method (API).

methodhvac.api.auth_methods.legacy_mfa.LegacyMfa.read_configuration(mount_point)

Read the MFA configuration.

classhvac.api.auth_methods.okta.Okta

Okta Auth Method (API).

methodhvac.api.auth_methods.okta.Okta.read_config(mount_point=DEFAULT_MOUNT_POINT)

Read the Okta configuration.

classhvac.api.auth_methods.radius.Radius

RADIUS Auth Method (API).

classhvac.api.auth_methods.token.Token

Token Auth Method (API).

methodhvac.api.auth_methods.token.Token.delete_role(role_name, mount_point=DEFAULT_MOUNT_POINT)

Delete the named token role.

methodhvac.api.auth_methods.token.Token.list_accessors(mount_point=DEFAULT_MOUNT_POINT)

List token accessors.

methodhvac.api.auth_methods.token.Token.list_roles(mount_point=DEFAULT_MOUNT_POINT)

List available token roles.

classhvac.api.auth_methods.userpass.Userpass

USERPASS Auth Method (API).

classhvac.api.secrets_engines.SecretsEngines

Secrets Engines.

classhvac.api.secrets_engines.active_directory.ActiveDirectory

Active Directory Secrets Engine (API).

classhvac.api.secrets_engines.aws.Aws

AWS Secrets Engine (API).

classhvac.api.secrets_engines.azure.Azure

Azure Secrets Engine (API).

classhvac.api.secrets_engines.consul.Consul

Copnsul Secrets Engine (API).

classhvac.api.secrets_engines.database.Database

Database Secrets Engine (API).

classhvac.api.secrets_engines.gcp.Gcp

Google Cloud Secrets Engine (API).

methodhvac.api.secrets_engines.gcp.Gcp.list_rolesets(mount_point=DEFAULT_MOUNT_POINT)

List configured rolesets.

methodhvac.api.secrets_engines.gcp.Gcp.read_roleset(name, mount_point=DEFAULT_MOUNT_POINT)

Read a roleset.

methodhvac.api.secrets_engines.gcp.Gcp.read_static_account(name, mount_point=DEFAULT_MOUNT_POINT)

Read a static account.

classhvac.api.secrets_engines.identity.Identity

Identity Secrets Engine (API).

methodhvac.api.secrets_engines.identity.Identity.delete_entity_alias(alias_id, mount_point=DEFAULT_MOUNT_POINT)

Delete a entity alias.

methodhvac.api.secrets_engines.identity.Identity.delete_group(group_id, mount_point=DEFAULT_MOUNT_POINT)

Delete a group.

methodhvac.api.secrets_engines.identity.Identity.delete_group_alias(entity_id, mount_point=DEFAULT_MOUNT_POINT)

Delete a group alias.

methodhvac.api.secrets_engines.identity.Identity.delete_named_key(name, mount_point=DEFAULT_MOUNT_POINT)

Delete a named key.

methodhvac.api.secrets_engines.identity.Identity.delete_role(name, mount_point=DEFAULT_MOUNT_POINT)

Deletes a role.

methodhvac.api.secrets_engines.identity.Identity.list_named_keys(mount_point=DEFAULT_MOUNT_POINT)

List all named keys.

methodhvac.api.secrets_engines.identity.Identity.rotate_named_key(name, verification_ttl, mount_point=DEFAULT_MOUNT_POINT)

Rotate a named key.

classhvac.api.secrets_engines.kv_v1.KvV1

KV Secrets Engine - Version 1 (API).

classhvac.api.secrets_engines.kv_v2.KvV2

KV Secrets Engine - Version 2 (API).

classhvac.api.secrets_engines.ldap.Ldap

LDAP Secrets Engine (API).

classhvac.api.secrets_engines.pki.Pki

Pki Secrets Engine (API).

methodhvac.api.secrets_engines.pki.Pki.create_or_update_role(name, extra_params=None, mount_point=DEFAULT_MOUNT_POINT)

Create/Update Role.

methodhvac.api.secrets_engines.pki.Pki.delete_issuer(issuer_ref, mount_point=DEFAULT_MOUNT_POINT)

Delete issuer.

methodhvac.api.secrets_engines.pki.Pki.delete_role(name, mount_point=DEFAULT_MOUNT_POINT)

Delete Role.

methodhvac.api.secrets_engines.pki.Pki.delete_root(mount_point=DEFAULT_MOUNT_POINT)

Delete Root.

method

hvac.api.secrets_engines.pki.Pki.generate_root(type, common_name, extra_params=None, mount_point=DEFAULT_MOUNT_POINT, wrap_ttl=None)

Generate Root.

methodhvac.api.secrets_engines.pki.Pki.list_certificates(mount_point=DEFAULT_MOUNT_POINT)

List Certificates.

methodhvac.api.secrets_engines.pki.Pki.list_issuers(mount_point=DEFAULT_MOUNT_POINT)

List issuers.

methodhvac.api.secrets_engines.pki.Pki.list_roles(mount_point=DEFAULT_MOUNT_POINT)

List Roles.

methodhvac.api.secrets_engines.pki.Pki.read_ca_certificate(mount_point=DEFAULT_MOUNT_POINT)

Read CA Certificate.

methodhvac.api.secrets_engines.pki.Pki.read_ca_certificate_chain(mount_point=DEFAULT_MOUNT_POINT)

Read CA Certificate Chain.

methodhvac.api.secrets_engines.pki.Pki.read_certificate(serial, mount_point=DEFAULT_MOUNT_POINT)

Read Certificate.

methodhvac.api.secrets_engines.pki.Pki.read_crl(mount_point=DEFAULT_MOUNT_POINT)

Read CRL.

methodhvac.api.secrets_engines.pki.Pki.read_crl_configuration(mount_point=DEFAULT_MOUNT_POINT)

Read CRL Configuration.

methodhvac.api.secrets_engines.pki.Pki.read_issuer(issuer_ref, mount_point=DEFAULT_MOUNT_POINT)

Read issuer.

methodhvac.api.secrets_engines.pki.Pki.read_role(name, mount_point=DEFAULT_MOUNT_POINT)

Read Role.

methodhvac.api.secrets_engines.pki.Pki.read_urls(mount_point=DEFAULT_MOUNT_POINT)

Read URLs.

methodhvac.api.secrets_engines.pki.Pki.revoke_certificate(serial_number, mount_point=DEFAULT_MOUNT_POINT)

Revoke Certificate.

methodhvac.api.secrets_engines.pki.Pki.revoke_issuer(issuer_ref, mount_point=DEFAULT_MOUNT_POINT)

Revoke issuer.

methodhvac.api.secrets_engines.pki.Pki.rotate_crl(mount_point=DEFAULT_MOUNT_POINT)

Rotate CRLs.

methodhvac.api.secrets_engines.pki.Pki.set_signed_intermediate(certificate, mount_point=DEFAULT_MOUNT_POINT)

Set Signed Intermediate.

methodhvac.api.secrets_engines.pki.Pki.set_urls(params, mount_point=DEFAULT_MOUNT_POINT)

Set URLs.

method

hvac.api.secrets_engines.pki.Pki.sign_certificate(name, csr, common_name, extra_params=None, mount_point=DEFAULT_MOUNT_POINT)

Sign Certificate.

methodhvac.api.secrets_engines.pki.Pki.sign_intermediate(csr, common_name, extra_params=None, mount_point=DEFAULT_MOUNT_POINT)

Sign Intermediate.

methodhvac.api.secrets_engines.pki.Pki.sign_self_issued(certificate, mount_point=DEFAULT_MOUNT_POINT)

Sign Self-Issued.

methodhvac.api.secrets_engines.pki.Pki.sign_verbatim(csr, name=False, extra_params=None, mount_point=DEFAULT_MOUNT_POINT)

Sign Verbatim.

methodhvac.api.secrets_engines.pki.Pki.submit_ca_information(pem_bundle, mount_point=DEFAULT_MOUNT_POINT)

Submit CA Information.

methodhvac.api.secrets_engines.pki.Pki.tidy(extra_params=None, mount_point=DEFAULT_MOUNT_POINT)

Tidy.

methodhvac.api.secrets_engines.pki.Pki.update_issuer(issuer_ref, extra_params=None, mount_point=DEFAULT_MOUNT_POINT)

Update issuer.

classhvac.api.secrets_engines.rabbitmq.RabbitMQ

RabbitMQ Secrets Engine (API).

classhvac.api.secrets_engines.ssh.Ssh

SSH Secrets Engine (API).

classhvac.api.secrets_engines.transform.Transform

Transform Secrets Engine (API).

classhvac.api.secrets_engines.transit.Transit

Transit Secrets Engine (API).

methodhvac.api.secrets_engines.transit.Transit.export_key(name, key_type, version=None, mount_point=DEFAULT_MOUNT_POINT)

Return the named key.

methodhvac.api.secrets_engines.transit.Transit.list_keys(mount_point=DEFAULT_MOUNT_POINT)

List keys (if there are any).

methodhvac.api.system_backend.auth.Auth.list_auth_methods()

List all enabled auth methods.

classhvac.api.system_backend.health.Health

methodhvac.api.system_backend.key.Key.cancel_rekey(recovery_key=False)

Cancel any in-progress rekey.

methodhvac.api.system_backend.lease.Lease.list_leases(prefix)

Retrieve a list of lease ids.

methodhvac.api.system_backend.lease.Lease.read_lease(lease_id)

Retrieve lease metadata.

methodhvac.api.system_backend.lease.Lease.revoke_lease(lease_id)

Revoke a lease immediately.

methodhvac.api.system_backend.namespace.Namespace.delete_namespace(path)

Delete a namespaces.

methodhvac.api.system_backend.namespace.Namespace.list_namespaces()

Lists all the namespaces.

methodhvac.api.system_backend.policies.Policies.list_acl_policies()

List all configured acl policies.

methodhvac.api.system_backend.policies.Policies.list_egp_policies()

List all configured egp policies.

methodhvac.api.system_backend.policies.Policies.list_rgp_policies()

List all configured rgp policies.

methodhvac.api.system_backend.policy.Policy.list_policies()

List all configured policies.

methodhvac.api.system_backend.quota.Quota.delete_quota(name)

Delete a given quota.

methodhvac.api.system_backend.quota.Quota.list_quotas()

Retrieve a list of quotas by name.

methodhvac.api.system_backend.quota.Quota.read_quota(name)

Read quota.

classhvac.api.system_backend.raft.Raft

Raft cluster-related system backend methods.

classhvac.api.system_backend.system_backend_mixin.SystemBackendMixin

Base class for System Backend API endpoints.

classhvac.api.vault_api_base.VaultApiBase

Base class for API endpoints.

classhvac.api.vault_api_category.VaultApiCategory

Base class for API categories.

funchvac.utils.get_token_from_env()

Get the token from env var, VAULT_TOKEN.

classhvac.v1.Client

The hvac Client class for HashiCorp's Vault.

methodhvac.v1.Client.adapter()

Adapter for all client's connections.

methodhvac.v1.Client.auth()

Accessor for the Client instance's auth methods.

methodhvac.v1.Client.login(url, use_token=True, **kwargs)

Perform a login request.

methodhvac.v1.Client.seal_status()

Read the seal status of the Vault.

methodhvac.v1.Client.write_data(path:str, *data:t.Optional[t.Dict[str, t.Any]]=None, *wrap_ttl:t.Optional[str]=None)

Write data to a path.

この情報について

掲載しているシグネチャは hvac/hvac の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る