auth.sessions¶

Returns a list of active auth sessions.

The credentials_data object varies by credentials type: password and socket sessions include username; API key sessions additionally include api_key (id and name); token sessions include parent (the originating credential) and optionally username.

Example:

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "auth.sessions",
    "params": []
}

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []
No Additional Items

Each item of this array must be:

Type: object

Parameter 2: options

options

Type: object

Default:

{ "relationships": true, "extend": null, "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

No Additional Properties

Relationships

Type: boolean Default: true

Extend

Default: null

Type: string

Type: null

Extend Context

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Prefix

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

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

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

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

Type: boolean Default: false

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

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

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

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

Type: boolean Default: false

Result

Any of

Type: array of object
No Additional Items

Each item of this array must be:

AuthSessionsEntry

Type: object
No Additional Properties

Id

Type: string

Current

Type: boolean

Internal

Type: boolean

Origin

Type: string

Credentials

Type: enum (of string)

Must be one of:

"UNIX_SOCKET"
"LOGIN_PASSWORD"
"LOGIN_TWOFACTOR"
"LOGIN_ONETIME_PASSWORD"
"API_KEY"
"TOKEN"
"TRUENAS_NODE"

Credentials Data

Any of

BaseCredentialData

Type: object

UserCredentialData

Type: object
No Additional Properties

Type: object

TokenCredentialData

Type: object
No Additional Properties

Type: object

Username

Any of

Option 1
Option 2

Type: string

Type: null

Username

Any of

Option 1
Option 2

Must be one of:

"UNIX_SOCKET"
"LOGIN_PASSWORD"
"LOGIN_TWOFACTOR"
"LOGIN_ONETIME_PASSWORD"
"API_KEY"
"TOKEN"
"TRUENAS_NODE"

Credentials Data

Any of

Type: object

Created At

Type: stringFormat: date-time

Secure Transport

Type: boolean

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: integer

Required roles: AUTH_SESSIONS_READ

Table Of Contents

Previous topic

Next topic

auth.sessions¶

Call parameters

Tuple Validation

Parameter 1: filters

filters

Each item of this array must be:

Parameter 2: options

options

relationships

Relationships

extend

Extend

Any of

extend_context

Extend Context

Any of

prefix

Prefix

Any of

extra

Extra

order_by

Order By

Each item of this array must be:

select

Select

Each item of this array must be:

Any of

Each item of this array must be:

count

Count

get

Get

offset

Offset

limit

Limit

force_sql_filters

Force Sql Filters

Return value

Result

Any of

Each item of this array must be:

AuthSessionsEntry

id Required

Id

current Required

Current

internal Required

Internal

origin Required

Origin

credentials Required

Credentials

Must be one of:

credentials_data Required

Credentials Data

Any of

BaseCredentialData

UserCredentialData

username Required

Username

login_at Required

Login At

APIKeyCredentialData

username Required

Username

login_at Required

Login At

api_key Required

APIKeySessionData

id Required

Id

name Required

Name

TokenCredentialData

parent Required