Global Settings Controller Resource

The API allows you to view and edit global settings.

GET /global-settings

Returns global settings details.

Response Body
media type data type description
application/json GlobalSettingsDetailsResponseDto (JSON) global settings details

Example

Request
GET /global-settings
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "modificationTime" : 1451649601000,
  "keycloakEnabled" : true,
  "backupRetentionOffset" : 12345
}

PUT /global-settings

Change global settings details.

Request Body
media type data type description
application/json GlobalSettingsUpdateRequestDto (JSON) specify global settings details to update
Response Body
media type data type description
application/json GlobalSettingsDetailsResponseDto (JSON) updated details of global settings

Example

Request
PUT /global-settings
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "modificationTime" : 1451649601000,
  "keycloakEnabled" : true,
  "backupRetentionOffset" : 12345
}

GET /global-settings/authentication-type

Response Body
media type data type description
application/json AuthenticationTypeResponseDto (JSON)

Example

Request
GET /global-settings/authentication-type
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

GET /global-settings/email-recipients

Response Body
media type data type description
application/json array of string (JSON)

Example

Request
GET /global-settings/email-recipients
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /global-settings/unmount

Returns global settings details for restore.

Response Body
media type data type description
application/json GlobalSettingsMountDetailsResponseDto (JSON) global settings details for restore

Example

Request
GET /global-settings/unmount
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

PUT /global-settings/email/password

Change password for email.

Request Body
media type data type description
application/json StringDTO (JSON) specify password for email

Example

Request
PUT /global-settings/email/password
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

POST /global-settings/email/test

Send test email.

Example

Request
POST /global-settings/email/test
Content-Type: */*

                
...
Response
HTTP/1.1 201 Created

PUT /global-settings/keycloak/auth-settings

Request Body
media type data type
application/json KeycloakAuthSettingsRequestDto (JSON)
Response Body
media type data type description
application/json DecodedCertificateResponseDto (JSON)

Example

Request
PUT /global-settings/keycloak/auth-settings
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

GET /global-settings/keycloak/refresh

Response Body
media type data type description
application/json DecodedCertificateResponseDto (JSON)

Example

Request
GET /global-settings/keycloak/refresh
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

PUT /global-settings/keycloak/secret

Change keycloak client secret

Request Body
media type data type description
application/json KeycloakSecretRequestDto (JSON) specify keycloak client secret

Example

Request
PUT /global-settings/keycloak/secret
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

GET /global-settings/keycloak/secret-enabled

Response Body
media type data type description
application/json KeycloakSecretEnabledResponseDto (JSON)

Example

Request
GET /global-settings/keycloak/secret-enabled
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

PUT /global-settings/ldap/password

Update Authentication LDAP password

Request Body
media type data type description
application/json StringDTO (JSON) specify Authentication LDAP password to update

Example

Request
PUT /global-settings/ldap/password
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content