API ReferenceSSH Key Group

Retrieve all SSH Key Groups

View as Markdown

Retrieve all SSH Key Groups 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

siteIdstringOptional
Filter SSH Key Groups by Site ID
instanceIdstringOptional
Filter SSH Key Groups by Instance ID
statusenumOptional
Status filter for the SSH Key Groups
Allowed values:
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 SSH Key Group
namestring
Name of the SSH Key Group
descriptionstring or null
Description for the SSH Key Group, optional
orgstring
Organization this SSH Key Group belongs to
tenantIdstringformat: "uuid"
ID of the Tenane the SSH Key Group belongs to
versionstring
Version of the SSH Key Group
sshKeyslist of objects
SSH Keys associated with this SSH Key Group
siteAssociationslist of objects
Sites the SSH Key Group is synced to
statusenum
Status of the SSH Key Group
Allowed values:
statusHistorylist of objects
History of the SSH Key Group states
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