API ReferenceSSH Key

Create SSH Key

View as Markdown

Create an SSH Key for the current Tenant. If an SSH Key Group is specified, all Sites associated with the SSH Key Group must be online.

Org must have a Tenant entity. User must have FORGE_TENANT_ADMIN authorization role.

Authentication

AuthorizationBearer
``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

Request

This endpoint expects an object.
namestringRequired
Name cannot match that name an existing SSH Key
publicKeystringRequiredformat: "^ssh-(rsa|ecdsa|ed25519) AAAA[0-9A-Za-z+/]+[=]{0,3}(\s+.+)?$"

Must be an SSH key of type: RSA, ECDSA or ED25519

sshKeyGroupIdstring or nullOptionalformat: "uuid"
ID of the SSH Key Group this key should be attached to

Response

Created
idstringRead-onlyformat: "uuid"
Unique identifier for the key
namestring
orgstring
tenantIdstringformat: "uuid"
fingerprintstring
SHA256 fingerprint of the public key
createddatetimeRead-only

Date/time when the SSH key was created

updateddatetimeRead-only

Date/time when the SSH key was last updated

Errors

400
Bad Request Error
403
Forbidden Error