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=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] [[--session=<sessionName>]] ] [--store=_variableName _ ] [--to-file=<outputFile>_]] <userNameOrId>
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.
Session options:
- --session=<sessionName>
-
Name of the FoD session to use for executing this command. Default value: default.
Output options:
- -o, --output=format[=<options>]
-
Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.
- --store=variableName[=<propertyNames>]
-
Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.
- --to-file=<outputFile>
-
Write command output to the specified file instead of stdout.
Generic fcli options:
- --env-prefix=<envPrefix>
-
Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.
- -h, --help
-
Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.
- --log-file=<logFile>
-
File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.
- --log-level=<logLevel>
-
Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.