keychaincredential.query

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

No Additional Items

Each item of this array must be:

Type: object

Examples:

[
    [
        "name",
        "=",
        "bob"
    ]
]

[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]

Parameter 2: options

options

Type: object

Default:

{ "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

Query options including pagination, ordering, and additional parameters.

No Additional Properties

extra

Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.

order_by

Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).

No Additional Items

Each item of this array must be:

Type: string

Example:

[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]

select

Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.

No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

Example:

[
    "username",
    "Authentication.status"
]

count

Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified query-filters.

get

Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.

offset

Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

limit

Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.

WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

Return value

Result

Any of

• Option 1
• KeychainCredentialQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

KeychainCredentialQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

Unique identifier for this keychain credential.

name

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

type

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

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.

KeychainCredentialQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

Unique identifier for this keychain credential.

name

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

type

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

Attributes

Credential-specific configuration and authentication data.

Any of

• Option 1
• Option 2

Type: object

Type: object

Type: integer

Required roles: KEYCHAIN_CREDENTIAL_READ