User Group Commands

uac user-group

User Group management commands, including listing, creating, updating, and deleting user groups

uac user-group [OPTIONS] COMMAND [ARGS]...

create

Create a User Group

uac user-group create [OPTIONS] sysId=value retainSysIds=value name=value
                      email=value description=value parent=value
                      ctrlNavigationVisibility=value

Options

-o, --output <output>

-i, --input <input>

Required

-s, --select <select>

select which field to be returned. JSONPATH

Arguments

sysId=value retainSysIds=value name=value email=value description=value parent=value ctrlNavigationVisibility=value

Optional argument(s)

delete

Delete a User Group

uac user-group delete [OPTIONS] groupid=value groupname=value

Options

-o, --output <output>

-s, --select <select>

select which field to be returned. JSONPATH

Arguments

groupid=value groupname=value

Required argument(s)

get

Read a User Group

uac user-group get [OPTIONS] groupid=value groupname=value

Options

-o, --output <output>

-s, --select <select>

select which field to be returned. JSONPATH

Arguments

groupid=value groupname=value

Required argument(s)

list

List User Groups

uac user-group list [OPTIONS]

Options

-o, --output <output>

-s, --select <select>

select which field to be returned. JSONPATH

-f, --format <table>

Output format (json or table). Defaults to output_options.default_stdout_format in config.yml.

Options:

json | table

-c, --columns <table_fields>

Comma-separated list of field names to display in table output. Supports dot notation for nested fields (e.g. name.label). Example: name,description,type

Arguments

update

Modify a User Group

uac user-group update [OPTIONS] sys_id=value exclude_related=value
                      retain_sys_ids=value name=value email=value
                      manager=value description=value parent=value
                      ctrl_navigation_visibility=value
                      navigation_visibility=value permissions=value
                      group_roles=value group_members=value

Options

-o, --output <output>

-i, --input <input>

Required

-s, --select <select>

select which field to be returned. JSONPATH

Arguments

sys_id=value exclude_related=value retain_sys_ids=value name=value email=value manager=value description=value parent=value ctrl_navigation_visibility=value navigation_visibility=value permissions=value group_roles=value group_members=value

Optional argument(s)