keychaincredential.update

Update a Keychain Credential with specific id.

Please note that you can’t change type. You must specify full attributes value.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

Unique identifier of the keychain credential to update.

Parameter 2: keychain_credential_update

keychain_credential_update

Updated credential configuration data.

Any of

• KeychainCredentialUpdateSSHKeyPairEntry
• KeychainCredentialUpdateSSHCredentialsEntry

KeychainCredentialUpdateSSHKeyPairEntry

Type: object
No Additional Properties

name

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

attributes

Attributes

Type: object

SSH key pair attributes including public and private keys.

No Additional Properties

private_key

Private Key

Default: null

SSH private key in OpenSSH format. null if only public key is provided.

Any of

• Option 1
• Option 2

Type: string

Type: null

public_key

Public Key

Default: null

Can be omitted and automatically derived from the private key.

Any of

• Option 1
• Option 2

Type: string

Type: null

KeychainCredentialUpdateSSHCredentialsEntry

Type: object
No Additional Properties

name

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

attributes

Attributes

Type: object

SSH connection attributes including host, authentication, and connection settings.

No Additional Properties

host Required

Host

Type: string

SSH server hostname or IP address.

port

Port

Type: integer Default: 22

SSH server port number.

username

Username

Type: string Default: "root"

SSH username for authentication.

private_key Required

Private Key

Type: integer

Keychain Credential ID.

remote_host_key Required

Remote Host Key

Type: string

Can be discovered with keychaincredential.remotesshhostkeyscan.

connect_timeout

Connect Timeout

Type: integer Default: 10

Connection timeout in seconds for SSH connections.

Return value

Result

The updated keychain credential entry.

Any of

• SSHKeyPairEntry
• SSHCredentialsEntry

SSHKeyPairEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for this keychain credential.

name Required

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

type Required

Type

Type: const

Keychain credential type identifier for SSH key pairs.

Must be one of:

• "SSH_KEY_PAIR"

Specific value: "SSH_KEY_PAIR"

attributes Required

Attributes

Type: object

SSH key pair attributes including public and private keys.

No Additional Properties

private_key

Private Key

Default: null

SSH private key in OpenSSH format. null if only public key is provided.

Any of

• Option 1
• Option 2

Type: string

Type: null

public_key

Public Key

Default: null

Can be omitted and automatically derived from the private key.

Any of

• Option 1
• Option 2

Type: string

Type: null

SSHCredentialsEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for this keychain credential.

name Required

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

type Required

Type

Type: const

Keychain credential type identifier for SSH connection credentials.

Must be one of:

• "SSH_CREDENTIALS"

Specific value: "SSH_CREDENTIALS"

attributes Required

Attributes

Type: object

SSH connection attributes including host, authentication, and connection settings.

No Additional Properties

host Required

Host

Type: string

SSH server hostname or IP address.

port

Port

Type: integer Default: 22

SSH server port number.

username

Username

Type: string Default: "root"

SSH username for authentication.

private_key Required

Private Key

Type: integer

Keychain Credential ID.

remote_host_key Required

Remote Host Key

Type: string

Can be discovered with keychaincredential.remotesshhostkeyscan.

connect_timeout

Connect Timeout

Type: integer Default: 10

Connection timeout in seconds for SSH connections.

Required roles: KEYCHAIN_CREDENTIAL_WRITE