SSH Certificate Authorities#

Do not construct this object directly, instead access the ssh_certificate_authorities property of an ngrok.Client object.

class ngrok.services.SSHCertificateAuthoritiesClient(client)[source]#

An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.

create(description='', metadata='', private_key_type='', elliptic_curve='', key_size=0)[source]#

Create a new SSH Certificate Authority

Parameters:

description (str) – human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
metadata (str) – arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
private_key_type (str) – the type of private key to generate. one of rsa, ecdsa, ed25519
elliptic_curve (str) – the type of elliptic curve to use when creating an ECDSA key
key_size (int) – the key size to use when creating an RSA key. one of 2048 or 4096

delete(id)[source]#

Delete an SSH Certificate Authority

Get detailed information about an SSH Certificate Authority

list(before_id=None, limit=None, filter=None)[source]#

List all SSH Certificate Authorities on this account

Parameters:

before_id (str) – Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limit (str) – Constrains the number of results in the dataset. See the API Overview for details.
filter (str) – A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

update(id, description=None, metadata=None)[source]#

Update an SSH Certificate Authority

Parameters:

id (str) –
description (str) – human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
metadata (str) – arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.