auth.sessions ============= Returns list of active auth sessions. Example of return value: [ { "id": "NyhB1J5vjPjIV82yZ6caU12HLA1boDJcZNWuVQM4hQWuiyUWMGZTz2ElDp7Yk87d", "origin": "192.168.0.3:40392", "credentials": "LOGIN_PASSWORD", "credentials_data": {"username": "root"}, "current": True, "internal": False, "created_at": {"$date": 1545842426070} } ] `credentials` can be `UNIX_SOCKET`, `ROOT_TCP_SOCKET`, `LOGIN_PASSWORD`, `API_KEY` or `TOKEN`, depending on what authentication method was used. For `UNIX_SOCKET` and `LOGIN_PASSWORD` logged-in `username` field will be provided in `credentials_data`. For `API_KEY` corresponding `api_key` will be provided in `credentials_data`. For `TOKEN` its `parent` credential will be provided in `credentials_data`. If you want to exclude all internal connections from the list, call this method with following arguments: [ [ ["internal", "=", True] ] ] .. raw:: html
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

Type: string
Type: null

Prefix

Default: null

Type: string
Type: null

Extra

Type: object Default: {}

Order By

Type: array of string Default: []
No Additional Items
Each item of this array must be:
Type: string

Select

Type: array Default: []
No Additional Items
Each item of this array must be:

Type: string
Type: array
No Additional Items
Each item of this array must be:
Type: object

Count

Type: boolean Default: false

Get

Type: boolean Default: false

Offset

Type: integer Default: 0

Limit

Type: integer Default: 0

Force Sql Filters

Type: boolean Default: false

Result


Type: array of object
No Additional Items
Each item of this array must be:

AuthSessionsQueryResultItem

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


BaseCredentialData

Type: object

UserCredentialData

Type: object
No Additional Properties

Username

Type: string

Login At

Type: stringFormat: date-time

APIKeyCredentialData

Type: object
No Additional Properties

Username

Type: string

Login At

Type: stringFormat: date-time

APIKeySessionData

Type: object
No Additional Properties

Id

Type: integer

Name

Type: string

TokenCredentialData

Type: object
No Additional Properties

TokenParentCredentialsData

Type: object
No Additional Properties

Credentials

Type: enum (of string)
Must be one of:
  • "UNIX_SOCKET"
  • "LOGIN_PASSWORD"
  • "LOGIN_TWOFACTOR"
  • "API_KEY"
  • "TOKEN"
  • "TRUENAS_NODE"

Credentials Data


BaseCredentialData

Type: object

UserCredentialData

Type: object
No Additional Properties

Username

Type: string

Login At

Type: stringFormat: date-time

APIKeyCredentialData

Type: object
No Additional Properties

Username

Type: string

Login At

Type: stringFormat: date-time

Type: object

TokenCredentialData

Type: object
No Additional Properties

Type: object

Username


Type: string
Type: null

Username


Type: string
Type: null

Created At

Type: stringFormat: date-time

Secure Transport

Type: boolean

AuthSessionsQueryResultItem

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


Type: object
Type: object
Type: object
Type: object

Created At

Type: stringFormat: date-time

Secure Transport

Type: boolean
Type: integer


*Required roles:* AUTH_SESSIONS_READ