group

Create a new Group in the vault

Pass a vault name in the vault field and the group label.

Example of the request that creates a new group in Team vault with external_id as client-123, label John Doe, ssh port 22, and ssh credentials in username and password properties, and SSH key in the key property:

  • path: /v1/group/client-123/
  • body:
    {
      "vault": "Team",
      "label": "John Doe",
      "ssh": {
        "port": 22,
        "credentials": {
          "username": "username",
          "password": "password",
          "key": {
            "label": "shared with the team",
            "private": "-----BEGIN OPENSSH PRIVATE KEY-----\nb3Blbn..."
          }
        }
      }
    }
    

Optionally, pass the parent group external_id in the group field instead of the vault. Create a parent group via this API before creating a nested group.

post/v1/group/{external_id}/

Request

  • Base URL
    https://termius.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

external_idstring required

Group ID in your original system, e.g., a client id.

Request body

groupstring required
vaultstring required
labelstring required

Example request

{
  "vault": "Team",
  "label": "Client John Doe"
}

Response

successful operation

CreateGroupResponse required

Changes

No recorded changes to this operation across all 1 revision of this API.