Description

The ccollab admin user edit command modifies an information about an existing Collaborator user.

Command Line Syntax

ccollab [global-options] admin user edit <user> [--admin <value>] [--email <value>] [--enabled <value>] [--first-name <value>] [--last-name <value>] [--full-name <value>] [--new-login <value>] [--password <value>] [--phone-number <value>] [--notification-level <value>] [--notification-wait-level <value>] [--notification-send-to-level <value>]

Command Options

Option

Required?

Description

<user>

Yes

Specifies the login or username of the existing user

--admin <value>

No

Specifies if the user will have administrator privileges (y/n/yes/no/true/false/on/off)

--email <value>

No

Email address

--enabled <value>

No

Specifies if the user will be enabled (y/n/yes/no/true/false/on/off)

--first-name <value>

No

First name (enclose value in quotes if first name includes spaces)

--last-name <value>

No

Last name (enclose value in quotes if last name includes spaces)

--full-name <value>

No

Full name (enclose value in quotes if full name includes spaces)

--new-login <value>

No

Specifies new login / username for the user

--password <value>

No

Password

--phone-number <value>

No

Phone number

--notification-level <value>

No

Specifies the level of email notifications (none/all/minimal). Case insensitive.

--notification-wait-level <value>

No

Specifies the default level of notifications when user performs the "Wait" action during reviews. Possible values are: "any activity occurs", "activity by author occurs", "file activity occurs", "someone pokes me".

--notification-send-to-level <value>

No

Specifies the default level of notifications when user performs the "Send To" action during reviews. Possible values are: "any activity occurs", "activity by author occurs", "file activity occurs", "someone pokes me".

Remarks

  • You must be an Administrator to disable users or edit the information of another user.

Examples

ccollab admin user edit alice --full-name "Alice Katharine Clark"

ccollab admin user edit bob --new-login bobcampbell

ccollab admin user edit jsmith --notification-level minimal

ccollab admin user edit admin --password newpassword

See Also

ccollab admin user

Highlight search results