keychaincredential.create

Create a Keychain Credential.

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

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: keychain_credential_create

keychain_credential_create

Any of

• KeychainCredentialCreateSSHKeyPairEntry
• KeychainCredentialCreateSSHCredentialsEntry

KeychainCredentialCreateSSHKeyPairEntry

Type: object
No Additional Properties

name Required

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

type Required

Type

Type: const

Must be one of:

• "SSH_KEY_PAIR"

Specific value: "SSH_KEY_PAIR"

attributes Required

Attributes

Type: object

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

No Additional Properties

private_key

Private Key

Default: null

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

KeychainCredentialCreateSSHCredentialsEntry

Type: object
No Additional Properties

name Required

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

type Required

Type

Type: const

Must be one of:

• "SSH_CREDENTIALS"

Specific value: "SSH_CREDENTIALS"

attributes Required

Attributes

Type: object
No Additional Properties

host Required

Host

Type: string

port

Port

Type: integer Default: 22

username

Username

Type: string Default: "root"

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

Return value

Result

Any of

• SSHKeyPairEntry
• SSHCredentialsEntry

SSHKeyPairEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

name Required

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

type Required

Type

Type: const

Must be one of:

• "SSH_KEY_PAIR"

Specific value: "SSH_KEY_PAIR"

attributes Required

Attributes

Type: object

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

No Additional Properties

private_key

Private Key

Default: null

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

name Required

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

type Required

Type

Type: const

Must be one of:

• "SSH_CREDENTIALS"

Specific value: "SSH_CREDENTIALS"

attributes Required

Attributes

Type: object
No Additional Properties

host Required

Host

Type: string

port

Port

Type: integer Default: 22

username

Username

Type: string Default: "root"

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

Required roles: KEYCHAIN_CREDENTIAL_WRITE