user.get_user_obj

Returns dictionary containing information from struct passwd for the user specified by either the username or uid. Bypasses user cache.

NOTE: results will not include nested groups for Active Directory users.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: get_user_obj

get_user_obj

Type: object
No Additional Properties

Username

Default: null

Type: string
Type: null

Uid

Default: null

Type: integer
Type: null

Get Groups

Type: boolean Default: false

Retrieve group list for the specified user.

Sid Info

Type: boolean Default: false

Retrieve SID and domain information for the user.

UserGetUserObj

Type: object
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 list 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.



Required roles: ACCOUNT_READ