Synopsis

fcli fod access-control update-user [--must-change] [--password-never-expires] [--suspended] [--email=<email>] [--firstname=<firstName>] [--lastname=<lastName>] [--password=<password>] [--phone=<phoneNumber>] [--role=<roleNameOrId>] [--add-apps=<addApplications>[, <addApplications>…​]]…​ [--add-groups=<addUserGroups>[, <addUserGroups>…​]]…​ [--remove-apps=<removeApplications>[, <removeApplications>…​]]…​ [--remove-groups=<removeUserGroups>[, <removeUserGroups>…​]]…​ [[-h] [--env-prefix=<prefix>] [--log-file=<logFile>] [--log-level=<logLevel>] [--log-mask=<level>] [--debug]] [[--fod-session=<sessionName>]] [[-o=<type+args>] [--style*=<style>,…​]…​ ] [--to-file=<outputFile>_]] <userNameOrId>

Description

Options

--add-apps, --add-applications=<addApplications>[,<addApplications>…​]

One or more comma-separated application id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

--add-groups=<addUserGroups>[,<addUserGroups>…​]

One or more comma-separated group id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric group names, you will need to specify the group id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

--email=<email>

The updated email address of the user.

--firstname=<firstName>

Updated first name of the user.

--lastname=<lastName>

Updated last name of the user.

--must-change

Set a flag to indicate that user’s password must be changed on next login.

--password=<password>

Updated user password.

--password-never-expires

Set a flag to indicate that the user’s password will never expire.

--phone, --phone-number=<phoneNumber>

Updated phone number of the user.

--remove-apps, --remove-applications=<removeApplications>[,<removeApplications>…​]

One or more comma-separated application id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

--remove-groups=<removeUserGroups>[,<removeUserGroups>…​]

One or more comma-separated group id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric group names, you will need to specify the group id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

--role=<roleNameOrId>

Updated id or name of the role the user should be given.

--suspended

Suspend the user.

FoD session name options

--fod-session=<sessionName>

Name of the FoD session to use for executing this command. Default value: default.

Output options (also see documentation link below)

-o, --output=<type+args>

Select output type (csv, table, expr, json, xml, yaml) and optional type arguments.

--store=<var>[:<prop>]

Store JSON results in an fcli variable for later reference.

*--style*=<style>,…​

Select output style: header, no-header, pretty, no-pretty, flat, no-flat, array, single, border, no-border, md-border.

--to-file=<outputFile>

Write output to the specified file.

Generic fcli options (also see documentation link below)

--debug

Enable collection of debug logs.

--env-prefix=<prefix>

Prefix for resolving default option values. Default value: FCLI_DEFAULT.

-h, --help

Use 'fcli [command] -h' to display help for fcli (sub-)commands.

--log-file=<logFile>

Write log output to file. Default: ./fcli.log if logging is enabled.

--log-level=<logLevel>

Set logging level: TRACE, DEBUG, INFO, WARN, ERROR, NONE.

--log-mask=<level>

Log mask level: high, medium, low, none. Default: medium. Masking is done on a best-effort basis; no guarantee that all sensitive data will be masked.

Arguments

<userNameOrId>

User id or username. Note that numeric values are always interpreted as id’s. If you have numeric user names, you will need to specify the user id.