Skip to content

Latest commit

 

History

History
132 lines (80 loc) · 3.06 KB

SettingsApi.md

File metadata and controls

132 lines (80 loc) · 3.06 KB

SettingsApi

All URIs are relative to https://<CROWD_URL>/rest/bootstrapi/1

Method HTTP request Description
getLoginPage GET /settings/branding/login-page Get the login-page settings
getSettings GET /settings Get the general settings
setLoginPage PUT /settings/branding/login-page Set the login-page settings
setLogo PUT /settings/branding/logo Set the logo
setSettings PUT /settings Set the general settings

getLoginPage

SettingsBrandingLoginPageBean getLoginPage()

Get the login-page settings

Parameters

This endpoint does not need any parameter.

Return type

SettingsBrandingLoginPageBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getSettings

SettingsBean getSettings()

Get the general settings

Parameters

This endpoint does not need any parameter.

Return type

SettingsBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

setLoginPage

SettingsBrandingLoginPageBean setLoginPage(SettingsBrandingLoginPageBean)

Set the login-page settings

Parameters

Name Type Description Notes
SettingsBrandingLoginPageBean SettingsBrandingLoginPageBean [optional]

Return type

SettingsBrandingLoginPageBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

setLogo

ErrorCollection setLogo(body)

Set the logo

Parameters

Name Type Description Notes
body Object [optional]

Return type

ErrorCollection

Authorization

basicAuth

HTTP request headers

  • Content-Type: image/*
  • Accept: application/json

setSettings

SettingsBean setSettings(SettingsBean)

Set the general settings

Parameters

Name Type Description Notes
SettingsBean SettingsBean

Return type

SettingsBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json