SSH Key

Retrieve all SSH Keys

Changed on

Retrieve all SSH Keys for the current Tenant.

Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

get/v2/org/{org}/nico/sshkey

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/sshkey
  • Auth
    HTTP bearer

Query parameters

sshKeyGroupIdstring

ID of the SSH Key Group

querystring

Search for matches across all SSH Keys. Input will be matched against the name field

includeRelation'Tenant'

Related entity to expand

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'NAME_ASC' | 'NAME_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

Response

idstring uuid

Unique identifier for the key

namestring

Name of the SSHKey

orgstring

Organization the SSHKey belongs to

tenantIdstring uuid

ID of the Tenant

fingerprintstring

SHA256 fingerprint of the public key

createdstring date-time

Date/time when the SSH key was created

updatedstring date-time

Date/time when the SSH key was last updated

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "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"
  }
]

Changes

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

  • 743151ffc158Revision changes
    • breaking

      removed the enum value STATUS_ASC from the query request parameter orderBy

    • breaking

      removed the enum value STATUS_DESC from the query request parameter orderBy