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

UserGetUserObjArgs parameters.

 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.

UserGetUserObjResult

Type: object

UserGetUserObjResult 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 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

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


Required roles: ACCOUNT_READ