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] ]

]

Type: object

Call parameters

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

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_context

Extend Context

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

prefix

Prefix

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extra

Extra

Type: object Default: {}

order_by

Order By

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

select

Select

Type: array Default: []
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

count

Count

Type: boolean Default: false

get

Get

Type: boolean Default: false

offset

Offset

Type: integer Default: 0

limit

Limit

Type: integer Default: 0

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Return value

Result

Any of

• Option 1
• AuthSessionsQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

AuthSessionsQueryResultItem

Type: object
No Additional Properties

id

Id

Type: string

current

Current

Type: boolean

internal

Internal

Type: boolean

origin

Origin

Type: string

credentials

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

Credentials Data

Any of

• BaseCredentialData
• UserCredentialData
• APIKeyCredentialData
• TokenCredentialData

BaseCredentialData

Type: object

UserCredentialData

Type: object
No Additional Properties

username Required

Username

Type: string

login_at Required

Login At

Type: stringFormat: date-time

APIKeyCredentialData

Type: object
No Additional Properties

username Required

Username

Type: string

login_at Required

Login At

Type: stringFormat: date-time

api_key Required

APIKeySessionData

Type: object
No Additional Properties

id Required

Id

Type: integer

name Required

Name

Type: string

TokenCredentialData

Type: object
No Additional Properties

parent Required

TokenParentCredentialsData

Type: object
No Additional Properties

credentials Required

Credentials

Type: enum (of string)

Must be one of:

• "UNIX_SOCKET"
• "LOGIN_PASSWORD"
• "LOGIN_TWOFACTOR"
• "API_KEY"
• "TOKEN"
• "TRUENAS_NODE"

credentials_data Required

Credentials Data

Any of

• BaseCredentialData
• UserCredentialData
• APIKeyCredentialData
• TokenCredentialData

BaseCredentialData

Type: object

UserCredentialData

Type: object
No Additional Properties

username Required

Username

Type: string

login_at Required

Login At

Type: stringFormat: date-time

APIKeyCredentialData

Type: object
No Additional Properties

username Required

Username

Type: string

login_at Required

Login At

Type: stringFormat: date-time

api_key Required

Type: object

TokenCredentialData

Type: object
No Additional Properties

parent Required

Type: object

username Required

Username

Any of

• Option 1
• Option 2

Type: string

Type: null

username Required

Username

Any of

• Option 1
• Option 2

Type: string

Type: null

created_at

Created At

Type: stringFormat: date-time

secure_transport

Secure Transport

Type: boolean

AuthSessionsQueryResultItem

Type: object
No Additional Properties

id

Id

Type: string

current

Current

Type: boolean

internal

Internal

Type: boolean

origin

Origin

Type: string

credentials

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

Credentials Data

Any of

• Option 1
• Option 2
• Option 3
• Option 4

Type: object

Type: object

Type: object

Type: object

created_at

Created At

Type: stringFormat: date-time

secure_transport

Secure Transport

Type: boolean

Type: integer

Required roles: AUTH_SESSIONS_READ