im edituser
edits a user
Synopsis
im edituser [--name=value] [--description=value] [--image=[none|default|<path>]] [--fullName=value] [--email=value] [--notificationRule=rule] [--notificationRuleFile=value] [--copyNotification=[user|group]:<name>] [--[no]active] [--user=name] [--hostname=server] [--password=password] [--port=number] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [--quiet] [-g|--gui] [--settingsUI=[gui|default]] [--status=[none|gui|default]] user
Description
im edituser edits a user for workflows and documents. You can edit the following user details: name, full user name, email address, status, image, description, and notifications. For example:
im edituser --description=MarketingManager jriley
changes the description for jriley.
Options
This command takes the universal options available to all
im commands, as well as some general options. See the
options reference page for descriptions.
• --name=value
specifies the new name of the user. Names can be a maximum of 100 characters and cannot contain square brackets.
|
|
PTC recommends you do not use commas, colons, or special characters in user names. If you use commas in the user name, you cannot select the user in a multi-valued user field. If you use colons in the user name, the user cannot edit shared system provided objects (charts, queries, reports, and dashboards).
|
• --description=value
specifies a description of the user.
• --image=[none|default|<path>]]
specifies whether an image appears for the user.
◦ --image=none does not specify an image for the user.
◦ --image=default specifies the default "person" image for the user.
◦ --image=<path> specifies the path and name of a custom image for the user, for example, c:\images\defect_icon.gif.
|
|
Images must be GIF or JPEG format, and no larger than 16 by 24 pixels.
|
• --fullName=value
specifies the full name of the user.
• --email=value
specifies the email address of the user.
• --notificationRule=rule
specifies the notification rule for this principal. For the rule syntax, see Specifying Rules on the
options reference page.
|
|
• To specify a date and time for a date field, use the MM/dd/yyyy h:mm:ss [AM|PM] format. You can specify a time only if the date field is configured to display the time. To specify the current date for a date field, type today. This option can be specified for a date field or a date field configured to display the date and time. To specify the current date and time for a date field, type now. This option can be specified only if the date field is configured to display the date and time. To specify an empty value for the date field, type none.
• When specifying a user, you can specify the user's name or "me". "me" is a symbolic user which refers to the user that the notification rule is created for. This is useful if you want to create a common notification rule and share it with other users.
• E-mail notification is subject to project, type, and field visibility rules. Only users that have visibility for a given project and type receive e-mail notification for issues related to that project and type. In addition, e-mail notifications include only the fields they have permission to view.
|
• --notificationRuleFile=value
specifies the file that contains the rules to read. For the file content format, see Specifying Rules on the
options reference page.
• --copyNotification=[user|group]:<name>
copies the given user/group's notification rules. This command copies the given user/group's notification rule into this user's at the time that the command is run.
• --[no]active
Specifies if the user is actively used in Integrity Lifecycle Manager. This option is useful for removing users that no longer exist in your organization. Specifying --noactive prevents the user from being displayed as an available default user field value; however, the user still appears in existing issue data.
|
|
If the user is referenced in a trigger assignment or as the default value in a user field, moving the user from active to inactive displays an error message. The reference must be removed before making the user inactive.
|
• user
specifies the name of user you want to edit.
See Also
• Commands:
• Miscellaneous:
