Team / Integrations /

List SSH identities

Lists the SSH identities saved to this account. Does not display SSH public keys.

Required permission

Account > Ssh > General > Read

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

identities
[array]

{object}
An array of SSH Identities

id
string required
ID of the docker credentials
min length
3
max length
39
pattern
^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$
name
string required
min length
3
max length
100
pattern
^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$
description
string
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
sshPublicKeys
[array]
A list of SSH public keys.

{object}

key
string required
The SSH public key.

restrictions
{object}
Configuration of restrictions.

projects
{object}
Configuration of project restriction settings.

enabled
boolean
Whether restriction by project should be enabled.
items
[array]
An array of previously defined projects.

string
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

tags
{object}
Configuration of tag restriction settings.

enabled
boolean
Whether restriction by tag should be enabled.
items
[array]
An array of previously defined tags to help identify and group the resource.

string
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

matchCondition
string
If all or any of the tags must be present on the target for it to match the condition.
one of
and, or

updatedAt
string
time of update
createdAt
string
time of creation

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

GET /v1/integrations/ssh-identities

GET /v1/teams/{teamId}/integrations/ssh-identities

Example response

200 OK

A list of SSH identities saved to this account.

JSON

{
  "data": {
    "identities": [
      {
        "id": "example-credentials",
        "name": "Example SSH Identity",
        "sshPublicKeys": [
          {
            "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ..."
          }
        ],
        "restrictions": {
          "projects": {
            "enabled": false
          },
          "tags": {
            "enabled": false,
            "matchCondition": "or"
          }
        }
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}