user.get_instance¶
Returns instance matching id. If id is not found, Validation error is raised.
Please see query method documentation for options.
Type: object
No Additional Properties
No Additional Items
No Additional Items
Email
Default: null
No Additional Items
No Additional Items
Type: array
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: integerParameter 2: options
options
Type: object Default: {}No Additional Properties
Relationships
Type: boolean Default: trueExtend
Default: null Type: string
Type: null
Extend Context
Default: null Type: string
Type: null
Prefix
Default: null Type: string
Type: null
Extra
Type: object Default: {}Order By
Type: array of string Default: []No Additional Items
Each item of this array must be:
Type: string
Select
Type: array Default: []No Additional Items
Each item of this array must be:
Type: string
Type: array
No Additional Items
No Additional Items
Each item of this array must be:
Type: object
Count
Type: boolean Default: falseGet
Type: boolean Default: falseOffset
Type: integer Default: 0Limit
Type: integer Default: 0Force Sql Filters
Type: boolean Default: falseUserEntry
Type: objectNo Additional Properties
Id
Type: integerUid
Type: integerUsername
Type: string
Type: string
Must be at least 1
characters long
Unixhash
Type: string
Type: null
Smbhash
Type: string
Type: null
Home
Type: string Default: "/var/empty"Must be at least 1
characters long
Shell
Type: string Default: "/usr/bin/zsh"Available choices can be retrieved with user.shell_choices
.
Must be at least 1
characters long
Full Name
Type: stringBuiltin
Type: booleanSmb
Type: boolean Default: trueGroup
Type: objectGroups
Type: array of integerSpecifies whether the user should be allowed access to SMB shares. User will also automatically be added to
the builtin_users
group.
Each item of this array must be:
Type: integer
Password Disabled
Type: boolean Default: falseSsh Password Enabled
Type: boolean Default: falseRequired if password_disabled
is false.
Sshpubkey
Default: null Type: string
Type: null
Locked
Type: boolean Default: falseSudo Commands
Type: array of stringNo Additional Items
Each item of this array must be:
Type: string
Must be at least 1
characters long
Sudo Commands Nopasswd
Type: array of stringNo Additional Items
Each item of this array must be:
Type: string
Must be at least 1
characters long
Type: stringFormat: email
Type: null
Id Type Both
Type: booleanLocal
Type: booleanImmutable
Type: booleanTwofactor Auth Configured
Type: booleanSid
Type: string
Type: null
Roles
Type: array of stringNo Additional Items
Each item of this array must be:
Type: string
Api Keys
Type: array of integerNo Additional Items
Each item of this array must be:
Type: integer
Required roles: