keychaincredential.query

Sent on keychaincredential changes.

Type: object

ADDED

KeychainCredentialAddedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

KeychainCredentialEntry

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: enum (of string)

Type of credential stored in the keychain.

• SSH_KEY_PAIR: SSH public/private key pair
• SSH_CREDENTIALS: SSH connection credentials including host and authentication

Must be one of:

• "SSH_KEY_PAIR"
• "SSH_CREDENTIALS"

attributes Required

Attributes

Credential-specific configuration and authentication data.

Any of

• SSHKeyPair
• SSHCredentials

SSHKeyPair

Type: object

At least one of the two keys must be provided on creation.

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

SSHCredentials

Type: object
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.

CHANGED

KeychainCredentialChangedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

KeychainCredentialEntry

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: enum (of string)

Type of credential stored in the keychain.

• SSH_KEY_PAIR: SSH public/private key pair
• SSH_CREDENTIALS: SSH connection credentials including host and authentication

Must be one of:

• "SSH_KEY_PAIR"
• "SSH_CREDENTIALS"

attributes Required

Attributes

Credential-specific configuration and authentication data.

Any of

• SSHKeyPair
• SSHCredentials

SSHKeyPair

Type: object

At least one of the two keys must be provided on creation.

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

SSHCredentials

Type: object
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.

REMOVED

KeychainCredentialRemovedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

Required roles: KEYCHAIN_CREDENTIAL_READ