SystemConfig
SystemConfig
[GET] /api/v1/sysconfig
The the system configurations.
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig
Update the system configurations.
Request Schema
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/name
Update the system name.
Request Schema
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/icon
Put the system icon.
Request Schema
Response
Status Code: 200
Success
[GET] /api/v1/sysconfig/icon
Get the system icon.
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/logo
Update the system logo.
Request Schema
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/bgimage
Update the background image of the login page.
Request Schema
Response
Status Code: 200
Success
[GET] /api/v1/sysconfig/passwordPolicy
Get current password policy.
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/passwordPolicy
Update current password policy.
Request Schema
Response
Status Code: 200
Success
[GET] /api/v1/sysconfig/lockedTime
Get the locked time of the current settings.
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/lockedTime
Update the locked time of the current settings.
Request Schema
Response
Status Code: 200
Success
[GET] /api/v1/sysconfig/global-organization
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/global-organization
Request Schema
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/css
Update the custom CSS content.
Request Schema
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/html
Update the custom HTML content.
Request Schema
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/email-settings
Update the email settings.
Request Schema
Response
Status Code: 200
Success
[GET] /api/v1/sysconfig/security-settings
Get the security settings.
Response
Status Code: 200
Success
[PUT] /api/v1/sysconfig/security-settings
Update the security settings.
Request Schema
Response
Status Code: 200
Success
Models
Ƭ SystemConfigBizModel
| Name | Type | Description | Example |
|---|---|---|---|
| companyNameNullable | string | ||
| sysIconNullable | string | ||
| logoNullable | string | ||
| bgImageNullable | string | ||
| passwordPolicy | PasswordPolicy | ||
| lockedTimeNullable | int32 | ||
| loginPageTipNullable | string | ||
| cssNullable | string | ||
| htmlNullable | string | ||
| allowUserResetPasswordNullable | Boolean | ||
| showGlobalTenantNullable | Boolean | ||
| defaultCookieLifetimeNullable | int32 | ||
| cookieLifetimeForRememberLoginNullable | int32 |
Ƭ PasswordPolicy
Enum:
WeakPasswordPolicyNormalPasswordPolicyStrongPasswordPolicy
Ƭ SysConfigDataModel
| Name | Type | Description | Example |
|---|---|---|---|
| dataNullable | string |
Ƭ GlobalTenantUpdateModel
| Name | Type | Description | Example |
|---|---|---|---|
| showGlobalTenant | Boolean |
Ƭ EmailSettingSMTPSettings
| Name | Type | Description | Example |
|---|---|---|---|
| serverAddressNullable | string | ||
| serverPort | int32 | ||
| enableSSL | Boolean | ||
| userNameNullable | string | ||
| passwordNullable | string | ||
| senderNameNullable | string | ||
| senderEmailNullable | string | ||
| emailSenderType | EmailSenderType | ||
| googleClientIdNullable | string | ||
| googleClientSecretNullable | string | ||
| googleTokensNullable | string |
Ƭ EmailSenderType
Enum:
SMTPGoogleAPI
Ƭ SystemConfigSecuritySettings
| Name | Type | Description | Example |
|---|---|---|---|
| passwordPolicy | PasswordPolicy | ||
| lockedTime | int32 | ||
| allowUserResetPassword | Boolean | ||
| defaultCookieLifetimeNullable | int32 | ||
| cookieLifetimeForRememberLoginNullable | int32 |