Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Modify User

  • Article
  • 1 minutes to read

Operation Information

Modify user account details using the usermod command

Input Parameters

Name Type Description Required Sensitive
username string User login name Yes No
MoveDir boolean Move the contents of the home directory to the new location: HomeDirectory Yes No
HomeDirectory string Absolute Path to new Home Directory No No
Password string Users new password No No
Comment string GCEOS field No No
LoginShell string Specifies the users login shell No No
GroupName string New Primary Group name No No
SuppGroupNames string Comma Separated list of group names No No
AccountExpiry string Expiry date format = yyyy-mm-dd No No
ExpiryDays string Number of days after password expiry until the account is disabled. No No
NewLoginName string Sets a new user name for the account No No
UserId string Sets new User ID for the user account No No
Cipher string Cipher No No

Output Parameters

Name Type Description Required Sensitive
Username string Username No No
UserId string User ID No No
Comment string Comment No No
HomeDirectory string Home Directory No No
Groups string Groups No No
outcome string Outcome of the operation. Can be OK or FAIL Yes No
errors string Any errors returned by the operation No No
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document