getConfig
Syntax
getConfig([key])
Details
Retrieve the configuration information of the system. Configuration items are internally classified into three security levels: sensitive, standard, and non-sensitive.
-
Sensitive configurations: clusterReplicationExecutionPassword, s3SecretAccessKey, oauthClientSecret, and metricsToken.
-
Non-sensitive configurations: webLoginRequired, webModules, oauth, oauthWebType, oauthAuthUri, oauthRedirectUri, and oauthClientId.
-
Standard configurations: all other configuration items not included in the above two categories.
When configuration access control is enabled
(enableConfigAccessControl=true), the function returns only
configuration items that the current user has permission to access. If access
control is not enabled, no permission checks are performed.
User permission description
| User Role | Non-sensitive Configuration | Standard Configuration | Sensitive Configuration |
|---|---|---|---|
| Guest users | Readable | Readable | Not readable |
| Non-administrator | Readable | Readable | Not readable |
| Administrator | Readable | Readable | Not readable |
For more information on the returned configuration parameters, see Configuration.
Arguments
key (optional) is a string indicating the name of a configuration parameter.
Returns
-
If key is not specified, return a dictionary with all configuration items that the current user has permission to read along with their corresponding values.
-
If key is specified:
-
If it is a valid configuration parameter and the user has read permission, return a string scalar or vector indicating the value(s) of the parameter.
-
If it is not a configuration parameter or a valid parameter without read permission, return a null value.
-