API ReferenceSSH Key

Retrieve all SSH Keys

View as Markdown

Retrieve all SSH Keys for the current Tenant.

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

Query parameters

sshKeyGroupIdstringOptional
ID of the SSH Key Group
querystringOptional
Search for matches across all Sites. Input will be matched against name field
includeRelationenumOptional
Related entity to expand
Allowed values:
pageNumberintegerOptional>=1Defaults to 1
Page number for pagination query
pageSizeintegerOptional1-100
Page size for pagination query
orderByenumOptional
Ordering for pagination query

Response

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

403
Forbidden Error