get-account¶

Description¶

Retrieves information about the CDP account.

Synopsis¶

  get-account
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

account -> (object)

Information about a Cloudera CDP account.

clouderaSSOLoginEnabled -> (boolean)

Whether interactive login using Cloudera SSO is enabled for users who are not account administrators. Its default value is ‘true’. When it is ‘true’, the account administrators, as well as non-administrator users can login through Cloudera SSO. When it is ‘false’, Cloudera SSO users who are not account administrators will not be able to login.

clouderaSSOAllLoginEnabled -> (boolean)

Whether login is enabled for Cloudera SSO users. It can only be set by Cloudera upon request and disables interactive login through Cloudera SSO. Note that restricting Cloudera SSO login will prevent account administrators from logging in interactively. Its default value is ‘true’. When it is ‘true’, the Cloudera SSO interactive login behavior is controlled according to the existing clouderaSSOLoginEnabled flag. When it is ‘false’, it overrides the setting for clouderaSSOLoginEnabled.

workloadPasswordPolicy -> (object)

Information about the workload password policy for an account.

maxPasswordLifetimeDays -> (integer)

The maximum lifetime, in days, of the password. If ‘0’ passwords never expire.

minPasswordLength -> (integer)

The minimum length of a password.

mustIncludeUpperCaseCharacters -> (boolean)

Whether passwords must include upper case characters.

mustIncludeLowerCaseCharacters -> (boolean)

Whether passwords must include lower case characters.

mustIncludeNumbers -> (boolean)

Whether passwords must include numbers.

mustIncludeSymbols -> (boolean)

Whether passwords must include symbols. The symbols are ‘#’, ‘&’, ‘*’, ‘$’, ‘%’, ‘@’, ‘^’, ‘.’, ‘_’, and ‘!’.

minPasswordLifetimeDays -> (integer)

The minimum lifetime of passwords, in days. The password must be used for this duration before it can be changed. If set to ‘0’ the password may be changed any time. The default is 0.

passwordHistorySize -> (integer)

The number of previous passwords that should be remembered. The user or machine user is prevented from reusing these passwords. Can be any number between 0 and 20. The default is 0, this value means all previous passwords may be reused.

machineUserWorkloadPasswordPolicy -> (object)

Information about the workload password policy for an account.

maxPasswordLifetimeDays -> (integer)

The maximum lifetime, in days, of the password. If ‘0’ passwords never expire.

minPasswordLength -> (integer)

The minimum length of a password.

mustIncludeUpperCaseCharacters -> (boolean)

Whether passwords must include upper case characters.

mustIncludeLowerCaseCharacters -> (boolean)

Whether passwords must include lower case characters.

mustIncludeNumbers -> (boolean)

Whether passwords must include numbers.

mustIncludeSymbols -> (boolean)

Whether passwords must include symbols. The symbols are ‘#’, ‘&’, ‘*’, ‘$’, ‘%’, ‘@’, ‘^’, ‘.’, ‘_’, and ‘!’.

minPasswordLifetimeDays -> (integer)

The minimum lifetime of passwords, in days. The password must be used for this duration before it can be changed. If set to ‘0’ the password may be changed any time. The default is 0.

passwordHistorySize -> (integer)

The number of previous passwords that should be remembered. The user or machine user is prevented from reusing these passwords. Can be any number between 0 and 20. The default is 0, this value means all previous passwords may be reused.

authenticationPolicy -> (object)

Information about the authentication policy for an account.

accessKeyInactivityDurationSec -> (integer)

The duration of inactivity (in seconds) required to invalidate the access key. A value of 0 indicates the system default is used (typically 1 hour, or 15 minutes for Cloudera for Government). A value greater than or equal to accessKeyExpirationSec indicates inactivity timeout is disabled.

accessKeyExpirationSec -> (integer)

The lifespan (in seconds) of the access key. A value of 0 indicates the system default is used (12 hours).

sessionTokenInactivityDurationSec -> (integer)

The duration of inactivity (in seconds) required to invalidate the UI session token. A value of 0 indicates the system default is used (typically 1 hour, or 15 minutes for Cloudera for Government). A value greater than or equal to sessionTokenExpirationSec indicates inactivity timeout is disabled.

sessionTokenExpirationSec -> (integer)

The lifespan (in seconds) of the UI session token. A value of 0 indicates the system default is used (12 hours).

workloadAuthTokenExpirationSec -> (integer)

The lifespan (in seconds) of the workload authentication token. A value of 0 indicates the system default is used (1 hour).

clientIpAddressesAllowed -> (array)

The list of IP addresses and/or CIDRs used for allowing client access to the UI and API services. Both the allowed list and the blocked list will be used to determine whether to grant or block the client’s access. The blocked list takes precedence over the allowed list. When the list is empty or not set, client IP address will not be validated to be present in the allowed list.

item -> (string)

clientIpAddressesBlocked -> (array)

The list of IP addresses and/or CIDRs used for blocking client access to the UI and API services. Both the allowed list and the blocked list will be used to determine whether to grant or block the client’s access. The blocked list takes precedence over the allowed list. When the list is empty or not set, client IP address will not be validated to be absent from the blocked list.

item -> (string)

allowedWorkloadSubdomains -> (array)

The list of allowed domains from which a workload-initiated SSO is allowed. Setting it will allow workload-initiated SSO from these domains as well as Cloudera’s default workload domains.

item -> (string)

Form Factors¶

public, private