keychaincredential.create

Create a Keychain Credential.

The following type`s are supported: * `SSH_KEY_PAIR * SSH_CREDENTIALS

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: keychain_credential_create

keychain_credential_create


Credential configuration data for the new keychain entry.

KeychainCredentialCreateSSHKeyPairEntry

Type: object
No Additional Properties

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

Type

Type: const

Keychain credential type identifier for SSH key pairs.

Must be one of:
  • "SSH_KEY_PAIR"
Specific value: "SSH_KEY_PAIR"

Attributes

Type: object

SSH key pair attributes including public and private keys.

 No Additional Properties

Private Key

Default: null

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

Type: string
Type: null

Public Key

Default: null

Can be omitted and automatically derived from the private key.

Type: string
Type: null

KeychainCredentialCreateSSHCredentialsEntry

Type: object
No Additional Properties

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

Type

Type: const

Keychain credential type identifier for SSH connection credentials.

Must be one of:
  • "SSH_CREDENTIALS"
Specific value: "SSH_CREDENTIALS"

Attributes

Type: object

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

 No Additional Properties

Host

Type: string

SSH server hostname or IP address.

Port

Type: integer Default: 22

SSH server port number.

Username

Type: string Default: "root"

SSH username for authentication.

Private Key

Type: integer

Keychain Credential ID.

Remote Host Key

Type: string

Can be discovered with keychaincredential.remotesshhostkeyscan.

Connect Timeout

Type: integer Default: 10

Connection timeout in seconds for SSH connections.

Result


The newly created keychain credential entry.

SSHKeyPairEntry

Type: object
No Additional Properties

Id

Type: integer

Unique identifier for this keychain credential.

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

Type

Type: const

Keychain credential type identifier for SSH key pairs.

Must be one of:
  • "SSH_KEY_PAIR"
Specific value: "SSH_KEY_PAIR"

Attributes

Type: object

SSH key pair attributes including public and private keys.

 No Additional Properties

Private Key

Default: null

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

Type: string
Type: null

Public Key

Default: null

Can be omitted and automatically derived from the private key.

Type: string
Type: null

SSHCredentialsEntry

Type: object
No Additional Properties

Id

Type: integer

Unique identifier for this keychain credential.

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

Type

Type: const

Keychain credential type identifier for SSH connection credentials.

Must be one of:
  • "SSH_CREDENTIALS"
Specific value: "SSH_CREDENTIALS"

Attributes

Type: object

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

 No Additional Properties

Host

Type: string

SSH server hostname or IP address.

Port

Type: integer Default: 22

SSH server port number.

Username

Type: string Default: "root"

SSH username for authentication.

Private Key

Type: integer

Keychain Credential ID.

Remote Host Key

Type: string

Can be discovered with keychaincredential.remotesshhostkeyscan.

Connect Timeout

Type: integer Default: 10

Connection timeout in seconds for SSH connections.


Required roles: KEYCHAIN_CREDENTIAL_WRITE