group.get_group_obj

Returns dictionary containing information from struct grp for the group specified by either the groupname or gid.

If sid_info is specified then addition SMB / domain information is returned for the group.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: get_group_obj

get_group_obj

Type: object
No Additional Properties

groupname

Groupname

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

gid

Gid

Default: null

Any of

• Option 1
• Option 2

Type: integer

Type: null

sid_info

Sid Info

Type: boolean Default: false

Return value

GroupGetGroupObjResult

Type: object
No Additional Properties

gr_name Required

Gr Name

Type: string

Name of the group.

gr_gid Required

Gr Gid

Type: integer

Group ID of the group.

gr_mem Required

Gr Mem

Type: array of string

List of group names that are members of the group.

No Additional Items

Each item of this array must be:

Type: string

sid

Sid

Default: null

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 name server switch module that provided the user. Options are:
FILES - local user in passwd file of server,
WINBIND - user provided by winbindd,
SSS - user provided by SSSD.

Must be one of:

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

local Required

Local

Type: boolean

Boolean indicating whether this group is local to the NAS or provided by a directory service.

Required roles: ACCOUNT_READ