User Commands

uac user

User management commands, including operations for creating, updating, and deleting users, as well as managing authentication tokens

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

add-group

Add a user’s group membership

uac user add-group [OPTIONS] userid=value username=value groupid=value
                   groupname=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

userid=value username=value groupid=value groupname=value: Optional argument(s)

change-password

Change a Universal Controller User Password

uac user change-password [OPTIONS] user_name=value new_password=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

user_name=value new_password=value: Required argument(s)

create

Create a User

uac user create [OPTIONS] sys_id=value retain_sys_ids=value user_name=value
                user_password=value first_name=value middle_name=value
                last_name=value email=value title=value active=value
                locked_out=value password_needs_reset=value
                business_phone=value mobile_phone=value time_zone=value
                department=value manager=value browser_access=value
                command_line_access=value web_service_access=value
                login_method=value impersonate=value permissions=value
                user_roles=value tokens=value"

Options

-o, --output <output>

-i, --input <input>: Required

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

sys_id=value retain_sys_ids=value user_name=value user_password=value first_name=value middle_name=value last_name=value email=value title=value active=value locked_out=value password_needs_reset=value business_phone=value mobile_phone=value time_zone=value department=value manager=value browser_access=value command_line_access=value web_service_access=value login_method=value impersonate=value permissions=value user_roles=value tokens=value": Optional argument(s)

create-token

Create Personal Access Token

uac user create-token [OPTIONS] name=token_name user_id=uuid
                      user_name=userName expiration=yyyy-mm-dd

Options

-o, --output <output>

-i, --input <input>: Required

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=token_name user_id=uuid user_name=userName expiration=yyyy-mm-dd: Optional argument(s)

delete

Delete a User

uac user delete [OPTIONS] userid=value username=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

userid=value username=value: Required argument(s)

delete-group

Deletes a user’s group membership

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

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

userid=value username=value groupid=value groupname=value: Optional argument(s)

get

Read a User

uac user get [OPTIONS] userid=value username=value show_tokens=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

userid=value username=value show_tokens=value: Required argument(s)

get-groups

Read a User’s group membership

uac user get-groups [OPTIONS] userid=value username=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

userid=value username=value: Optional argument(s)

get-preference

Read a User Preference

uac user get-preference [OPTIONS] preferencename=value userid=value
                        username=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

preferencename=value userid=value username=value: Optional argument(s)

list

List Users

uac user list [OPTIONS] show_tokens=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

show_tokens=value: Optional argument(s)

list-auth-tokens

List Personal Access Tokens

uac user list-auth-tokens [OPTIONS] userid=value username=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

userid=value username=value: Optional argument(s)

list-preferences

List User Preferences

uac user list-preferences [OPTIONS] userid=value username=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

userid=value username=value: Optional argument(s)

revoke-token

Revoke Personal Access Token

uac user revoke-token [OPTIONS] userid=value username=value tokenname=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

userid=value username=value tokenname=value: Required argument(s)

update

Modify a User

uac user update [OPTIONS] sys_id=value exclude_related=value
                retain_sys_ids=value user_name=value user_password=value
                first_name=value middle_name=value last_name=value email=value
                title=value active=value locked_out=value
                password_needs_reset=value business_phone=value
                mobile_phone=value time_zone=value department=value
                manager=value browser_access=value command_line_access=value
                web_service_access=value login_method=value impersonate=value
                permissions=value user_roles=value tokens=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 user_name=value user_password=value first_name=value middle_name=value last_name=value email=value title=value active=value locked_out=value password_needs_reset=value business_phone=value mobile_phone=value time_zone=value department=value manager=value browser_access=value command_line_access=value web_service_access=value login_method=value impersonate=value permissions=value user_roles=value tokens=value: Optional argument(s)

update-preference

Update a User Preference

uac user update-preference [OPTIONS] preferencename=value userid=value
                           username=value value=value

Options

-o, --output <output>

Arguments

preferencename=value userid=value username=value value=value: Optional argument(s)