auth.me

Returns currently logged-in user.

Type: object

Call parameters

Type: array
No Additional Items

Return value

AuthMeResult

Type: object
No Additional Properties

pw_name Required

Pw Name

Type: string

Name of the user.

pw_gecos Required

Pw Gecos

Type: string

Full username or comment field.

pw_dir Required

Pw Dir

Type: string

User home directory.

pw_shell Required

Pw Shell

Type: string

User command line interpreter.

pw_uid Required

Pw Uid

Type: integer

Numerical user ID of the user.

pw_gid Required

Pw Gid

Type: integer

Numerical group id for the user's primary group.

grouplist Required

Grouplist

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

Any of

• Option 1
• Option 2

Type: array of integer
No Additional Items

Each item of this array must be:

Type: integer

Type: null

sid Required

Sid

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

Any of

• Option 1
• Option 2

Type: string

Type: null

source Required

Source

Type: enum (of string)

The source for the user account.

Must be one of:

• "LOCAL"
• "ACTIVEDIRECTORY"
• "LDAP"

local Required

Local

Type: boolean

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

attributes Required

Attributes

Type: object

two_factor_config Required

Two Factor Config

Type: object

privilege Required

Privilege

Type: object

account_attributes Required

Account Attributes

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Required roles: