# 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

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: get_group_obj

#### get_group_obj

Type: object

GroupGetGroupObjArgs parameters.

No Additional Properties

##

#### Groupname

Default: null

Name of the group to look up or `null`.

## Any of

Type: string
Type: null

##

#### Gid

Default: null

Group ID to look up or `null`.

## Any of

Type: integer
Type: null

##

#### Sid Info

Type: boolean Default: false

Whether to include SID information in the response.

##

#### GroupGetGroupObjResult

Type: object

GroupGetGroupObjResult return fields.

No Additional Properties

##

#### Gr Name

Type: string

Name of the group.

##

#### Gr Gid

Type: integer

Group ID of the group.

##

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

Default: null

Optional SID value for the account that is present if `sid_info` is specified in payload.

## Any of

Type: string
Type: null

##

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

Type: boolean

This group is local to the NAS or provided by a directory service.

Required roles: ACCOUNT_READ