Identity

Update Identity

Updates an existing authentication identity's configuration such as credentials or connection settings.

patch/identity/{identityId}

Request

  • Base URL: https://docs.nexterm.dev/api
  • URL: https://docs.nexterm.dev/api/identity/{identityId}
  • Auth: HTTP bearer

Path parameters

identityIdstring required

The unique identifier of the identity to update

Request body

namestring

Name (1-255 characters)

usernamestring

Username (maximum 255 characters)

type'password' | 'ssh' | 'both' | 'password-only'

Type (allowed values: password, ssh, both, password-only)

passwordstring

Password

sshKeystring

Ssh key

passphrasestring

Passphrase

organizationIdinteger

Organization id

Response

Identity successfully updated

object required

Changes

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