Skip to main content

client.key

KeyClient Objects​

class KeyClient()

Provides functionality to interact with the Bloock Keys service

__init__​

def __init__(config_data=None) -> None

Creates a new KeyClient with the given configuration.

new_local_key​

def new_local_key(key_type: KeyType) -> LocalKey

Generates a new local key of the specified type.

load_local_key​

def load_local_key(key_type: KeyType, key: str) -> LocalKey

Loads a local key of the specified type from a public key string.

new_managed_key​

def new_managed_key(params: ManagedKeyParams) -> ManagedKey

Generates a new managed key with the specified parameters.

load_managed_key​

def load_managed_key(id: str) -> ManagedKey

Loads a managed key by its ID (ex: 51d22546-68f1-4340-b94b-2a80e60b8933).

new_local_certificate​

def new_local_certificate(params: LocalCertificateParams) -> LocalCertificate

Generates a new local certificate with the specified parameters.

load_local_certificate​

def load_local_certificate(pkcs12: bytes, password: str) -> LocalCertificate

Loads a local certificate from a PKCS12 file.

new_managed_certificate​

def new_managed_certificate(
        params: ManagedCertificateParams) -> ManagedCertificate

Generates a new managed certificate with the specified parameters.

load_managed_certificate​

def load_managed_certificate(id: str) -> ManagedCertificate

Loads a managed certificate by its ID (ex: ceef5b02-af17-43d8-ae7b-31d9bdf8027f).

import_managed_certificate​

def import_managed_certificate(
        _type: CertificateType, certificate: bytes,
        params: ImportCertificateParams) -> ManagedCertificate

Imports a managed certificate with the specified parameters, supported types: .pem, .pfx.

setup_totp_access_control​

def setup_totp_access_control(key: Managed) -> TotpAccessControlReceipt

Sets up TOTP-based access control for the given managed key or managed certificate.

recover_totp_access_control​

def recover_totp_access_control(key: Managed,
                                code: str) -> TotpAccessControlReceipt

Recovers TOTP-based access control for the given managed key or managed certificate using a recovery code.

setup_secret_access_control​

def setup_secret_access_control(key: Managed, secret: str, email: str)

Sets up secret-based access control for the given managed key or managed certificate.

Last updated on