CLI for User Admin

...

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.

Info
NOTE: If Single Sign On is enabled, you must specify your SSO credentials here instead. See below.

All

admin_password

Password of the admin account.

Info
NOTE: If Single Sign On is enabled, you must specify your SSO credentials here instead. See below.

Info

NOTE: If you have enabled Kerberos-based access to the

D s platform

, you do not need to provide a password. To enable, additional configuration is required. See Configure for Kerberos Integration.

Info
NOTE: Passwords can be stored in an external file, which is automatically checked during script execute. See CLI Config File.

All

verbose

Generate verbose output.

Info
NOTE: This parameter is required.

All

admin_command_type

The type of CLI command to execute. Accepted values:

create_user - Create a new user account with the specified credentials.
show_user - Retrieve account information for the specified user account.
edit_user - Modify the specified user account.
get_password_reset_url - Generate a password reset URL for a specified user.
delete_user - Delete the specified user account.

See Examples below.

All

host

(Optional) The server and port number of the

D s item

item	instance
r	true

. By default, this value is set to http://localhost:3005. Specify a new value if needed.

Info

NOTE: When SSO is enabled, you must specify this value to point to the Apache server port where the

d-s-item
item
node

authentication gateway listens. When running the CLI on the

d-s-item
item
node

, this value is typically the following:

Code Block
https://localhost:2443

See below.

Info
NOTE: In some environments, the `http://` or `https://` protocol identifier may be required as part of the `host` value.

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.

Info
NOTE: In the response, this value is listed as `email` .

All

password

Password of the account to be modified.

Info

NOTE: If you have enabled Kerberos-based access to the

D s platform

, you do not need to provide a password. To enable, additional configuration is required. See Configure for Kerberos Integration.

All

name

Display name for the user.

Info
NOTE: This parameter is required.

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.

Info

NOTE: If you have stored a self-signed certificate on the

d-s-item
item
node

, please set the REQUESTS_CA_BUNDLE environment variable to point to the directory that contains the trusted server's certificate(s). The CLI will verify against these certs. In this case, the disable_ssl_certificate parameter is not needed.

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.

Info
NOTE: Assets cannot be transferred to another user before or after the user deletion command. If assets are not transferred, they remain unowned in the system and are not removed from any form of storage.

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.

Info

NOTE: In an SSO environment, the default admin user account for the

D s platform

does not work. The issuing user must be an SSO user that has been promoted to admin within the

D s platform

.

admin_password Use the password associated with the SSO username.

host

This value must point to the SSO gateway on the

d-s-item
item
node

and must include the port number. If you are running the CLI on the

d-s-item
item
node

, use the following:

Code Block
https://localhost:2443

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.

...

Page tree

Versions Compared

Old Version 2

New Version Current

Key