API ReferenceSSH Key Group

Update an SSH Key Group

View as Markdown

Update a specific SSH Key Group.

SSH Key Group must be owned by current Tenant. All Sites being added or removed must be online to proceed.

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
sshKeyGroupIdstringRequired

Request

This endpoint expects an object.
versionstringRequired
Version of the SSH Key Group being modified must be provided
namestring or nullOptional
descriptionstring or nullOptional
siteIdslist of stringsOptional
When specified, replaces existing Site associations
sshKeyIdslist of stringsOptional
When specified, replaces existing SSH Key associations

Response

OK
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

400
Bad Request Error
403
Forbidden Error