Create SSH Key Group | NVIDIA Infra Controller

curl -X POST https://carbide-rest-api.carbide.svc.cluster.local/v2/org/org/carbide/sshkeygroup \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "reno-integration-sre",
  "description": "SRE access SSH keys for Reno Integration",
  "siteIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "sshKeyIds": [
    "ff06da79-707a-4069-8623-211d49ae96c8"
  ]
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "reno-integration-sre",
  "description": "SRE access SSH keys for Reno Integration",
  "org": "wdksahew1rqf",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "version": "fbc692b61ffef6fbfc38a3833f6b7e7ae508da75",
  "sshKeys": [
    {
      "id": "ff06da79-707a-4069-8623-211d49ae96c8",
      "name": "sre-ssh-reno",
      "org": "wdksahew1rqf",
      "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
      "fingerprint": "CaK2yoj5fDOhf1swM2kFyjQrd3bwZfDYlWnVjBHgveQ",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "siteAssociations": [
    {
      "site": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "sjc-central-1",
        "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
        "isSerialConsoleEnabled": true,
        "isOnline": true,
        "capabilities": {
          "nativeNetworking": true,
          "networkSecurityGroup": true
        },
        "status": "Registered"
      },
      "status": "Syncing",
      "version": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "status": "Syncing",
  "statusHistory": [
    {
      "status": "Syncing",
      "message": "Group is being synced to Sites",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}

Create an SSH Key Group 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

``` 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

descriptionstringOptional

siteIdslist of stringsOptional

sshKeyIdslist of stringsOptional

Response

Created

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