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

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: get_user_obj

get_user_obj

Type: object
No Additional Properties

username

Username

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

uid

Uid

Default: null

Any of

• Option 1
• Option 2

Type: integer

Type: null

get_groups

Get Groups

Type: boolean Default: false

retrieve group list for the specified user.

sid_info

Sid Info

Type: boolean Default: false

retrieve SID and domain information for the user.

Return value

UserGetUserObj

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

boolean value indicating whether the account is local to TrueNAS or provided by a directory service.

Required roles: ACCOUNT_READ