Skip to main content
PATCH
/
ssh_user_certificates
/
{id}
Update
curl --request PATCH \
  --url https://api.ngrok.com/ssh_user_certificates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '{
  "id": "<string>",
  "description": "<string>",
  "metadata": "<string>"
}'
{
  "id": "<string>",
  "uri": "<string>",
  "created_at": "<string>",
  "description": "<string>",
  "metadata": "<string>",
  "public_key": "<string>",
  "key_type": "<string>",
  "ssh_certificate_authority_id": "<string>",
  "principals": [
    "<string>"
  ],
  "critical_options": {},
  "extensions": {},
  "valid_after": "<string>",
  "valid_until": "<string>",
  "certificate": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
ngrok-version
integer
default:2
required

Path Parameters

​
id
string
required

Body

application/json
​
id
string

n/a

​
description
string

human-readable description of this SSH User Certificate. optional, max 255 bytes.

​
metadata
string

arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.

Response

200 - application/json

Update an SSH User Certificate

​
id
string

unique identifier for this SSH User Certificate

​
uri
string

URI of the SSH User Certificate API resource

​
created_at
string

timestamp when the SSH User Certificate API resource was created, RFC 3339 format

​
description
string

human-readable description of this SSH User Certificate. optional, max 255 bytes.

​
metadata
string

arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.

​
public_key
string

a public key in OpenSSH Authorized Keys format that this certificate signs

​
key_type
string

the key type of the public_key, one of rsa, ecdsa or ed25519

​
ssh_certificate_authority_id
string

the ssh certificate authority that is used to sign this ssh user certificate

​
principals
string[]

the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.

​
critical_options
object

A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.

​
extensions
object

A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.

​
valid_after
string

the time when the ssh host certificate becomes valid, in RFC 3339 format.

​
valid_until
string

the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.

​
certificate
string

the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive