Certificate Authorities#
Do not construct this object directly, instead access the
certificate_authorities property of an ngrok.Client object.
- class ngrok.services.CertificateAuthoritiesClient(client)[source]#
Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.
- create(ca_pem, description='', metadata='')[source]#
Upload a new Certificate Authority
- Parameters:
description (
str) – human-readable description of this Certificate Authority. optional, max 255 bytes.metadata (
str) – arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.ca_pem (
str) – raw PEM of the Certificate Authority
https://ngrok.com/docs/api#api-certificate-authorities-create
- Return type:
- delete(id)[source]#
Delete a Certificate Authority
- Parameters:
id (
str) – a resource identifier
https://ngrok.com/docs/api#api-certificate-authorities-delete
- get(id)[source]#
Get detailed information about a certficate authority
- Parameters:
id (
str) – a resource identifier
https://ngrok.com/docs/api#api-certificate-authorities-get
- Return type:
- list(before_id=None, limit=None)[source]#
List all Certificate Authority on this account
- Parameters:
before_id (
str) –limit (
str) –
https://ngrok.com/docs/api#api-certificate-authorities-list
- Return type:
- update(id, description=None, metadata=None)[source]#
Update attributes of a Certificate Authority by ID
- Parameters:
id (
str) –description (
str) – human-readable description of this Certificate Authority. optional, max 255 bytes.metadata (
str) – arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
https://ngrok.com/docs/api#api-certificate-authorities-update
- Return type: