...
Parameter | Description | Applicable CLI Commands | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
admin_username | Username of the admin account to be used to execute the user admin command. Please specify the full username.
| All | ||||||||||||||||||
admin_password | Password of the admin account.
| All | ||||||||||||||||||
verbose | Generate verbose output.
| All | ||||||||||||||||||
admin_command_type | The type of CLI command to execute. Accepted values:
| All | ||||||||||||||||||
host | (Optional) The server and port number of the
http://localhost:3005 . Specify a new value if needed.
| All | ||||||||||||||||||
user_name | Username of the account to be modified. This value is the user ID. It must resolve to a valid, accessible email address. Some features of the platform fail to work correctly with invalid email addresses.
| All | ||||||||||||||||||
password | Password of the account to be modified.
| All | ||||||||||||||||||
name | Display name for the user.
| create_user and edit_user if making changes to this parameter. | ||||||||||||||||||
disable_ssl_certification | (Optional) When communicating over HTTPS, this setting can be used to override the default behavior of validating the server certificate before executing the command.
| All | ||||||||||||||||||
disable | (Optional) Put the user in a disabled state. | create_user and edit_user | ||||||||||||||||||
enable | (Optional) Put the user in an enabled state. Default is to enable the user. | create_user and edit_user | ||||||||||||||||||
transfer_assets_to | (Optional) When deleting a user, you can optionally transfer all of the user's assets to another user.
| delete_user |
...
Property | Description | Editable through CLI? |
---|---|---|
--hadoopPrincipal | Hadoop principal value that is used to connect to the Hadoop environmentcluster. This setting applies only when secure impersonation is enabled. | Y |
--outputHomeDir | The output home directory for the user. By default, the results of each job executed by the user are generated in a sub-directory within this one. | Y |
--name | The display name for the user. | Y |
--isDisabled | When set to True , the user account is disabled and cannot be used to login to the application. | Y |
--email | The email address associated with the user account. The email address is also the userID for the account. | Y |
--ssoPrincipal | The SSO principal value associated with the user account. This value only applies to environments that are integrated with an enterprise Single Sign On solution. | Y |
--enableAdmin | When set to True , this user account is a system administrator account. You should limit the number of accounts that have system administrator access. | Y |
--disableAdmin | When set to True , this user account is not a system administrator account. You should limit the number of accounts that have system administrator access. | Y |
--lastLoginTime | The timestamp of when the user account was most recently used to login to the application. | N |
...
Property | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
admin_username | Use the SSO username for the platform admin user issuing the command.
| ||||||||
admin_password | Use the password associated with the SSO username. | ||||||||
host | This value must point to the SSO gateway on the
For more information, see Configure SSO for AD-LDAP. | ||||||||
ssoPrincipal | In SSO environments, this parameter is required. It must be set to the SSO principal value associated with the user that is being modified. |
...