s3.accesskey.get_instance

Returns instance matching id. If id is not found, Validation error is raised.

Please see query method documentation for options.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

Parameter 2: options

options

Type: object

Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.

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.

Value must be greater or equal to 0

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.

Value must be greater or equal to 0 and lesser or equal to 10000

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

S3AccesskeyEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for the access key.

name Required

Name

Type: string

Human-readable name for the access key.

Must be at least 1 characters long

Must be at most 200 characters long

username Required

Username

Account the access key belongs to, or null if that account no longer exists.

Any of

• Option 1
• Option 2
• Option 3

Type: string

Type: string

Must be at least 1 characters long

Type: null

user_identifier Required

User Identifier

Stored account linkage. A numeric user ID for local accounts or a SID for directory services accounts.

Any of

• Option 1
• Option 2

Type: integer

Type: string

local Required

Local

Type: boolean

Whether the access key belongs to a local user account rather than a directory services one.

access_key Required

Access Key

Type: string

The S3 access key id clients sign requests with.

Must match regular expression: ^[A-Z0-9]{16,128}$

secret Required

Secret

The S3 secret access key. Readable only by administrators holding SHARING_S3_WRITE; redacted for everyone else. null when the secret was lost to a configuration restore without the secret seed.

Any of

• Option 1
• Option 2

Type: string

Type: null

enabled Required

Enabled

Type: boolean

Whether the access key may be used. A disabled key is refused by the S3 service.

expires_at

Expires At

Default: null

Expiration timestamp for the access key or null for no expiration.

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

created_at Required

Created At

Type: stringFormat: date-time

Timestamp when the access key was created.

status Required

Status

Type: enum (of string)

Effective state of the access key. Only ENABLED keys are usable. DISABLED was set by an administrator, EXPIRED passed its expiration, USER_MISSING belongs to a directory account that no longer resolves (a deleted local account takes its keys with it), and SECRET_LOST lost its secret to a configuration restore without the secret seed and must be rotated.

Must be one of:

• "ENABLED"
• "DISABLED"
• "EXPIRED"
• "USER_MISSING"
• "SECRET_LOST"

Required roles: SHARING_S3_READ