auth.me

Returns currently logged-in user.

Type: object

Type: array
No Additional Items

AuthMeResult

Type: object

AuthMeResult return fields.

No Additional Properties

Pw Name

Type: string

Name of the user.

Pw Gecos

Type: string

Full username or comment field.

Pw Dir

Type: string

User home directory.

Pw Shell

Type: string

User command line interpreter.

Pw Uid

Type: integer

Numerical user ID of the user.

Pw Gid

Type: integer

Numerical group id for the user's primary group.

Grouplist


Optional array of group IDs for groups of which this account is a member. If get_groups is not specified, this value will be null.

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

Sid


Optional SID value for the account that is present if sid_info is specified in payload.

Type: string
Type: null

Source

Type: enum (of string)

The source for the user account.

Must be one of:
  • "LOCAL"
  • "ACTIVEDIRECTORY"
  • "LDAP"

Local

Type: boolean

The account is local to TrueNAS or provided by a directory service.

Attributes

Type: object

Custom user attributes and metadata.

Two Factor Config

Type: object

Two-factor authentication configuration for the user.

ComposedPrivilege

Type: object

User privilege and role information.

No Additional Properties

Roles

Type: array of string

Names of every role the credential holds, including the roles those roles include. Empty for a credential that was granted access by allowlist alone.

All items must be unique

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

Allowlist

Type: array of object

Method/resource pairs the credential may call, as method and resource keys. A single entry of */* grants unrestricted access.

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

Each additional property must conform to the following schema

Type: string

Web Shell

Type: boolean Default: false

Whether the credential may use the web shell. Always false under STIG.

Webui Access

Type: boolean Default: false

Whether the credential may log in to the web UI.

Account Attributes

Type: array of string

Array of account attribute names available for this user.

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


Required roles: