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] ] 
]
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 ItemsEach item of this array must be:
[
    [
        "name",
        "=",
        "bob"
    ]
]
[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]
Parameter 2: options
options
Type: objectQuery 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. 
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). 
Each item of this array must be:
[
    "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. 
Each item of this array must be:
No Additional Items
Each item of this array must be:
[
    "username",
    "Authentication.status"
]
Count
Type: boolean Default: falseReturn a numeric value representing the number of items that match the specified query-filters. 
Get
Type: boolean Default: falseReturn 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: 0This 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
Type: integer Default: 0This 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
Type: boolean Default: falseResult
No Additional Items
Each item of this array must be:
AuthSessionsQueryResultItem
Type: objectNo Additional Properties
Id
Type: stringCurrent
Type: booleanInternal
Type: booleanOrigin
Type: stringCredentials
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: objectUserCredentialData
Type: objectNo Additional Properties
Username
Type: stringLogin At
Type: stringFormat: date-timeAPIKeyCredentialData
Type: objectNo Additional Properties
Username
Type: stringLogin At
Type: stringFormat: date-timeAPIKeySessionData
Type: objectNo Additional Properties
Id
Type: integerName
Type: stringTokenCredentialData
Type: objectNo Additional Properties
TokenParentCredentialsData
Type: objectNo 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: objectUserCredentialData
Type: objectNo Additional Properties
Username
Type: stringLogin At
Type: stringFormat: date-timeAPIKeyCredentialData
Type: objectNo Additional Properties
Username
Type: stringLogin At
Type: stringFormat: date-timeTokenCredentialData
Type: objectNo Additional Properties
Username
Username
Created At
Type: stringFormat: date-timeSecure Transport
Type: booleanAuthSessionsQueryResultItem
Type: objectNo Additional Properties
Id
Type: stringCurrent
Type: booleanInternal
Type: booleanOrigin
Type: stringCredentials
Type: enum (of string)Must be one of:
- "UNIX_SOCKET"
- "LOGIN_PASSWORD"
- "LOGIN_TWOFACTOR"
- "LOGIN_ONETIME_PASSWORD"
- "API_KEY"
- "TOKEN"
- "TRUENAS_NODE"
Credentials Data
Created At
Type: stringFormat: date-timeSecure Transport
Type: booleanRequired roles: AUTH_SESSIONS_READ