AdministrationService Service

Use the AdministrationService service to manage the Oracle Analytics safe domains and configure log level.

Method Name Description

deleteCSPWhitelist() Method

Deletes all safe domains entries. Use with caution.

getCSPDefaultAllowList() Method

This method is used internally by Oracle Analytics to return the default entries for the content security policy required by the product functionality.

getCSPWhitelist() Method

Retrieves the list of domains and options specified in the safe domains configuration.

reloadLogConfiguration() Method

Reloads the log configuration.

updateCSPWhitelist() Method

Updates the current set of domains and allowed options in the content security policy that's sent to the web browsers.

deleteCSPWhitelist() Method

Use the deleteCSPWhitelist() method to delete all safe domains entries. Use with caution.

Signature

deleteCSPWhitelistResult deleteCSPWhitelist(String sessionID);

Argument Description

String sessionID

Specifies the session ID.

Returns

Returns deleteCSPWhitelistResult.

getCSPDefaultAllowList() Method

The getCSPDefaultAllowList() method is used internally by Oracle Analytics to return the default entries for the content security policy required by product functionality.

You can use REST APIs to create, update, and delete safe domains. See Safe Domains REST Endpoints.

Signature

getCSPDefaultAllowList(String sessionID);

Argument Description

String sessionID

Specifies the session ID.

Returns

Returns an output as defined in the getCSPWhitelist structure. See CSPWhitelist Structure.

getCSPWhitelist() Method

Use the getCSPWhitelist() method to obtain the current set of domains and allowed options in the content security policy that is sent to web browsers.

Signature

getCSPWhitelist(String sessionID);

Argument Description

String sessionID

Specifies the session ID.

Returns

Returns an output as defined in the getCSPWhitelist structure. See CSPWhitelist Structure.

reloadLogConfiguration() Method

Use the reloadLogConfiguration() method to reload the log configuration.

Signature

reloadLogConfigurationResult reloadLogConfiguration(LogReloadLevel logLevel, LogReloadDomain domain, String id, String sessionID);

Argument Description

LogReloadLevel logLevel

Specifies the logging level. Defined using one of these log levels in the LogReloadLevel enumeration:

  • DEFAULT

  • INCIDENT

  • ERROR

  • WARNING

  • INFORMATION

  • TRACE

  • DISABLED

LogReloadDomain domain

Specifies the domain to reload. Defined using one of these domains in the LogReloadDomain enumeration:

  • SYSTEM

  • TENANT

  • SESSION

String id

Specifies the system ID.

String sessionID

Specifies the session ID.

Returns

Returns reloadLogConfigurationResult.

updateCSPWhitelist() Method

Use the updateCSPWhitelist() method to update the current set of domains and allowed options in the content security policy that is sent to web browsers.

Signature

updateCSPWhitelist(String cspWhitelistXml, String sessionID);

Argument Description

String cspWhitelistXml

Specifies the content security policy in the CSPWhitelist structure. See CSPWhitelistXml Structure.

String sessionID

Specifies the session ID.

Returns

Returns confirmation of the updated CSP whitelist.