Skip to content

settings.md

Latest commit

 

History

History
553 lines (361 loc) · 15.2 KB

settings.md

File metadata and controls

553 lines (361 loc) · 15.2 KB

SettingsResource

Accessed via $enhance->settings.

Method Route
addOrchdLoginPolicyEmailBlacklist PUT /settings/orchd/login-policy/email-blacklist
addOrchdLoginPolicyEmailWhitelist PUT /settings/orchd/login-policy/email-whitelist
addOrchdLoginPolicyIpBlacklist PUT /settings/orchd/login-policy/ip-blacklist
addOrchdLoginPolicyIpWhitelist PUT /settings/orchd/login-policy/ip-whitelist
addOrchdLoginPolicySettings PUT /settings/orchd/login-policy/settings
createBackupRemoteStorageS3 POST /v2/settings/backup/remote_storage/s3
createSettings POST /settings
deleteBackupRemoteStorageS3 DELETE /v2/settings/backup/remote_storage/s3
deleteGlobalServiceSetting DELETE /settings/service/{setting_kind}/{setting_key}
deleteOrchdLoginPolicyEmailBlacklist DELETE /settings/orchd/login-policy/email-blacklist
deleteOrchdLoginPolicyEmailWhitelist DELETE /settings/orchd/login-policy/email-whitelist
deleteOrchdLoginPolicyIpBlacklist DELETE /settings/orchd/login-policy/ip-blacklist
deleteOrchdLoginPolicyIpWhitelist DELETE /settings/orchd/login-policy/ip-whitelist
deleteSetting DELETE /settings/{name}
getAdminLockdownList GET /settings/orchd/admin-lockdown/list
getAdminLockdownStatus GET /settings/orchd/admin-lockdown/status
getBackupRemoteStorageS3 GET /v2/settings/backup/remote_storage/s3
getDemoMode GET /v2/settings/demo_mode
getGlobalServiceSetting GET /settings/service/{setting_kind}
getOrchdLogSettings GET /settings/orchd/logs
getOrchdLoginPolicyEmailBlacklist GET /settings/orchd/login-policy/email-blacklist
getOrchdLoginPolicyEmailWhitelist GET /settings/orchd/login-policy/email-whitelist
getOrchdLoginPolicyIpBlacklist GET /settings/orchd/login-policy/ip-blacklist
getOrchdLoginPolicyIpWhitelist GET /settings/orchd/login-policy/ip-whitelist
getOrchdLoginPolicySettings GET /settings/orchd/login-policy/settings
getProhibitedDomains GET /settings/orchd/prohibited_domains
getSetting GET /settings/{name}
getSettings GET /settings
setAdminLockdownList PUT /settings/orchd/admin-lockdown/list
setAdminLockdownStatus PUT /settings/orchd/admin-lockdown/status
setGlobalServiceSetting PUT /settings/service/{setting_kind}/{setting_key}
setOrchdLogSettings PUT /settings/orchd/logs
setProhibitedDomains PUT /settings/orchd/prohibited_domains
updateBackupRemoteStorageS3 PATCH /v2/settings/backup/remote_storage/s3
updateSetting PUT /settings/{name}

addOrchdLoginPolicyEmailBlacklist

Set the orchd login policy email blacklist as a whole

PUT /settings/orchd/login-policy/email-blacklist

Parameter Type Required
$orchdLoginPolicyEmailList OrchdLoginPolicyEmailList yes 
use GoSuccess\Enhance\DTO\OrchdLoginPolicyEmailList;

$orchdLoginPolicyEmailList = new OrchdLoginPolicyEmailList();

$result = $enhance->settings->addOrchdLoginPolicyEmailBlacklist($orchdLoginPolicyEmailList);

addOrchdLoginPolicyEmailWhitelist

Set the orchd login policy email whitelist as a whole

PUT /settings/orchd/login-policy/email-whitelist

Parameter Type Required
$orchdLoginPolicyEmailList OrchdLoginPolicyEmailList yes 
use GoSuccess\Enhance\DTO\OrchdLoginPolicyEmailList;

$orchdLoginPolicyEmailList = new OrchdLoginPolicyEmailList();

$result = $enhance->settings->addOrchdLoginPolicyEmailWhitelist($orchdLoginPolicyEmailList);

addOrchdLoginPolicyIpBlacklist

Set the orchd login policy ip blacklist as a whole

PUT /settings/orchd/login-policy/ip-blacklist

Parameter Type Required
$orchdLoginPolicyIpList OrchdLoginPolicyIpList yes 
use GoSuccess\Enhance\DTO\OrchdLoginPolicyIpList;

$orchdLoginPolicyIpList = new OrchdLoginPolicyIpList();

$result = $enhance->settings->addOrchdLoginPolicyIpBlacklist($orchdLoginPolicyIpList);

addOrchdLoginPolicyIpWhitelist

Set the orchd login policy ip whitelist as a whole

PUT /settings/orchd/login-policy/ip-whitelist

Parameter Type Required
$orchdLoginPolicyIpList OrchdLoginPolicyIpList yes 
use GoSuccess\Enhance\DTO\OrchdLoginPolicyIpList;

$orchdLoginPolicyIpList = new OrchdLoginPolicyIpList();

$result = $enhance->settings->addOrchdLoginPolicyIpWhitelist($orchdLoginPolicyIpList);

addOrchdLoginPolicySettings

Set a single orchd login policy setting

PUT /settings/orchd/login-policy/settings

Parameter Type Required
$orchdLoginPolicySettings OrchdLoginPolicySettings yes 
use GoSuccess\Enhance\DTO\OrchdLoginPolicySettings;

$orchdLoginPolicySettings = new OrchdLoginPolicySettings();
$orchdLoginPolicySettings->enabled = true;
$orchdLoginPolicySettings->emailQuota = 10;
$orchdLoginPolicySettings->emailAutoBlockEnabled = true;
// ... set further properties as needed

$result = $enhance->settings->addOrchdLoginPolicySettings($orchdLoginPolicySettings);

createBackupRemoteStorageS3

Create S3 object storage settings at platform level.

POST /v2/settings/backup/remote_storage/s3

Parameter Type Required
$createBackupRemoteStorageS3 CreateBackupRemoteStorageS3 yes 
use GoSuccess\Enhance\DTO\CreateBackupRemoteStorageS3;
use GoSuccess\Enhance\Enum\RemoteStoragePurpose;

$createBackupRemoteStorageS3 = new CreateBackupRemoteStorageS3();
$createBackupRemoteStorageS3->purpose = RemoteStoragePurpose::Backup;
$createBackupRemoteStorageS3->region = 'example';
$createBackupRemoteStorageS3->endpoint = 'example';
// ... set further properties as needed

$result = $enhance->settings->createBackupRemoteStorageS3($createBackupRemoteStorageS3);

createSettings

Create settings

POST /settings

Parameter Type Required
$items ?array yes 
$result = $enhance->settings->createSettings([]);

deleteBackupRemoteStorageS3

Delete S3 object storage settings at platform level.

DELETE /v2/settings/backup/remote_storage/s3

$result = $enhance->settings->deleteBackupRemoteStorageS3();

deleteGlobalServiceSetting

Delete a single global service setting

DELETE /settings/service/{setting_kind}/{setting_key}

Parameter Type Required
$settingKind SettingKind yes
$settingKey string yes 
use GoSuccess\Enhance\Enum\SettingKind;

$result = $enhance->settings->deleteGlobalServiceSetting(SettingKind::PhpIni, 'example');

deleteOrchdLoginPolicyEmailBlacklist

Delete an orchd login policy email blacklist

DELETE /settings/orchd/login-policy/email-blacklist

Parameter Type Required
$orchdLoginPolicyEmailList OrchdLoginPolicyEmailList yes 
use GoSuccess\Enhance\DTO\OrchdLoginPolicyEmailList;

$orchdLoginPolicyEmailList = new OrchdLoginPolicyEmailList();

$result = $enhance->settings->deleteOrchdLoginPolicyEmailBlacklist($orchdLoginPolicyEmailList);

deleteOrchdLoginPolicyEmailWhitelist

Delete an orchd login policy email whitelist

DELETE /settings/orchd/login-policy/email-whitelist

Parameter Type Required
$orchdLoginPolicyEmailList OrchdLoginPolicyEmailList yes 
use GoSuccess\Enhance\DTO\OrchdLoginPolicyEmailList;

$orchdLoginPolicyEmailList = new OrchdLoginPolicyEmailList();

$result = $enhance->settings->deleteOrchdLoginPolicyEmailWhitelist($orchdLoginPolicyEmailList);

deleteOrchdLoginPolicyIpBlacklist

Delete an orchd login policy ip blacklist

DELETE /settings/orchd/login-policy/ip-blacklist

Parameter Type Required
$orchdLoginPolicyIpList OrchdLoginPolicyIpList yes 
use GoSuccess\Enhance\DTO\OrchdLoginPolicyIpList;

$orchdLoginPolicyIpList = new OrchdLoginPolicyIpList();

$result = $enhance->settings->deleteOrchdLoginPolicyIpBlacklist($orchdLoginPolicyIpList);

deleteOrchdLoginPolicyIpWhitelist

Delete an orchd login policy ip whitelist

DELETE /settings/orchd/login-policy/ip-whitelist

Parameter Type Required
$orchdLoginPolicyIpList OrchdLoginPolicyIpList yes 
use GoSuccess\Enhance\DTO\OrchdLoginPolicyIpList;

$orchdLoginPolicyIpList = new OrchdLoginPolicyIpList();

$result = $enhance->settings->deleteOrchdLoginPolicyIpWhitelist($orchdLoginPolicyIpList);

deleteSetting

Remove the specified setting

DELETE /settings/{name}

Parameter Type Required
$name string yes 
$result = $enhance->settings->deleteSetting('example');

getAdminLockdownList

Get the list of allowed IPs for master organisation login, line separated

GET /settings/orchd/admin-lockdown/list

$result = $enhance->settings->getAdminLockdownList();

getAdminLockdownStatus

Check if master organisation IP lockdown is enabled

GET /settings/orchd/admin-lockdown/status

$result = $enhance->settings->getAdminLockdownStatus();

getBackupRemoteStorageS3

Get S3 object storage settings at platform level.

GET /v2/settings/backup/remote_storage/s3

$result = $enhance->settings->getBackupRemoteStorageS3();

getDemoMode

Get the demo mode status of the orchd service

GET /v2/settings/demo_mode

$result = $enhance->settings->getDemoMode();

getGlobalServiceSetting

Get the value for a particular global service setting

GET /settings/service/{setting_kind}

Parameter Type Required
$settingKind SettingKind yes 
use GoSuccess\Enhance\Enum\SettingKind;

$result = $enhance->settings->getGlobalServiceSetting(SettingKind::PhpIni);

getOrchdLogSettings

Get the orchd log settings

GET /settings/orchd/logs

$result = $enhance->settings->getOrchdLogSettings();

getOrchdLoginPolicyEmailBlacklist

Get the orchd login policy email blacklist

GET /settings/orchd/login-policy/email-blacklist

$result = $enhance->settings->getOrchdLoginPolicyEmailBlacklist();

getOrchdLoginPolicyEmailWhitelist

Get the orchd login policy email whitelist

GET /settings/orchd/login-policy/email-whitelist

$result = $enhance->settings->getOrchdLoginPolicyEmailWhitelist();

getOrchdLoginPolicyIpBlacklist

Get the orchd login policy ip blacklist

GET /settings/orchd/login-policy/ip-blacklist

$result = $enhance->settings->getOrchdLoginPolicyIpBlacklist();

getOrchdLoginPolicyIpWhitelist

Get the orchd login policy ip whitelist

GET /settings/orchd/login-policy/ip-whitelist

$result = $enhance->settings->getOrchdLoginPolicyIpWhitelist();

getOrchdLoginPolicySettings

Get the orchd login policy settings

GET /settings/orchd/login-policy/settings

$result = $enhance->settings->getOrchdLoginPolicySettings();

getProhibitedDomains

Get the platform level prohibited domains as a newline separated list

GET /settings/orchd/prohibited_domains

$result = $enhance->settings->getProhibitedDomains();

getSetting

Get the specified setting

GET /settings/{name}

Parameter Type Required
$name string yes 
$result = $enhance->settings->getSetting('example');

getSettings

Get all current settings

GET /settings

$result = $enhance->settings->getSettings();

setAdminLockdownList

Set admin lockdown list as a whole

PUT /settings/orchd/admin-lockdown/list

Parameter Type Required
$value ?string yes 
$result = $enhance->settings->setAdminLockdownList('example');

setAdminLockdownStatus

Set admin lockdown status

PUT /settings/orchd/admin-lockdown/status

Parameter Type Required
$value ?bool yes 
$result = $enhance->settings->setAdminLockdownStatus(true);

setGlobalServiceSetting

Set a single global service setting

PUT /settings/service/{setting_kind}/{setting_key}

Parameter Type Required
$settingKind SettingKind yes
$settingKey string yes
$body mixed yes 
use GoSuccess\Enhance\Enum\SettingKind;

$result = $enhance->settings->setGlobalServiceSetting(SettingKind::PhpIni, 'example', null);

setOrchdLogSettings

Set the orchd log settings

PUT /settings/orchd/logs

Parameter Type Required
$orchdLogSettings OrchdLogSettings yes 
use GoSuccess\Enhance\DTO\OrchdLogSettings;
use GoSuccess\Enhance\Enum\LogLevelLimit;

$orchdLogSettings = new OrchdLogSettings();
$orchdLogSettings->limit = LogLevelLimit::Error;

$result = $enhance->settings->setOrchdLogSettings($orchdLogSettings);

setProhibitedDomains

Set the platform level prohibited domains

PUT /settings/orchd/prohibited_domains

Parameter Type Required
$value ?string yes 
$result = $enhance->settings->setProhibitedDomains('example');

updateBackupRemoteStorageS3

Update S3 object storage settings at platform level.

PATCH /v2/settings/backup/remote_storage/s3

Parameter Type Required
$updateBackupRemoteStorageS3 UpdateBackupRemoteStorageS3 yes 
use GoSuccess\Enhance\DTO\UpdateBackupRemoteStorageS3;

$updateBackupRemoteStorageS3 = new UpdateBackupRemoteStorageS3();
$updateBackupRemoteStorageS3->region = 'example';
$updateBackupRemoteStorageS3->endpoint = 'example';
$updateBackupRemoteStorageS3->bucket = 'example';
// ... set further properties as needed

$result = $enhance->settings->updateBackupRemoteStorageS3($updateBackupRemoteStorageS3);

updateSetting

Create or update the specified setting

PUT /settings/{name}

Parameter Type Required
$name string yes
$body mixed yes 
$result = $enhance->settings->updateSetting('example', null);