Skip to content

PrivateKeyMaterial

Part of Configuration & authentication in the Python API reference.

Related guidance: getting-started/configuration, getting-started/authentication, security/credentials.

Runnable examples: preflight.py.

from picogrid_ecn_client import PrivateKeyMaterial

Provide a private key from a filesystem path or secret PEM text.

PrivateKeyMaterial(
*,
path: Path | None = None,
data: SecretStr | None = None,
password: SecretStr | None = None,
)

Source · auth.py

NameTypeRequiredDefaultConstraintsDescription
pathPath | NonenoNoneOptional private-key file path; mutually exclusive with in-memory data.
dataSecretStr | NonenoNoneOptional secret in-memory PEM key; mutually exclusive with path and excluded from representations and public error text.
passwordSecretStr | NonenoNoneOptional private-key password whose value is excluded from representations and public error text.

Version 0.2.0 · branch main