hubcli user modify

Modifies the properties of an existing user.

The command has the following format:

hubcli user modify [flags] username

flags

One or more optional flags that provide additional control over execution of the command.

username

Specifies the user name to modify.

The following flags are available:

-c string or --connection string

Specifies the name of the connection to use. If you do not specify this option, then the default connection is used. If there is no default connection, then you must specify a connection. The first connection created for the Altair SLC Hub instance is set by default as the default Altair SLC Hub instance, but a different default connection can be set using the hubcli connection use command.

--debug

Enables debug logging.

--displayName text

Specifies a display name for the user. This enables you to provide a more user-friendly name that can be displayed in lists and the Altair SLC Hub Portal.

--email address

Specifies the email address of the user.

--firstName name

Specifies the first name of the user.

-h or --help

Returns help information for this command.

--lastName name

Specifies the last name of the user.

--unixHomeDirectory dir

Specifies the Unix home directory to associate with the user.

--unixUserName uname

Specifies a Unix username for the user.

--userPrincipalName upn

Specifies a Windows UPN for the user.

Examples

The following command updates the display name and email address of user jsmith:

hubcli user modify jsmith --displayName="John R. Smith" [email protected]
User jsmith successfully modified

Running hubcli user get jsmith confirms the changes:

 User Details
 User Name            jsmith
 Enabled              true
 Display Name         John R. Smith
 Email                [email protected]
 ID                   ede05508-9cb2-43a1-b7ee-bae86f7cd3ed
 Created              2026-09-09 08:17:56 UTC
 Unix Username        jsmith
 Unix Home Directory  /home/jsmith