SystemConfig

[GET] /api/v1/sysconfig

Get the system configuration record.

Responses

[200] Success

[PUT] /api/v1/sysconfig

Update the system configuration.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

SystemConfigBizModel

Responses

[200] Success

[PUT] /api/v1/sysconfig/name

Update the company name.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

SysConfigDataModel

Responses

[200] Success

[PUT] /api/v1/sysconfig/icon

Update the favicon of the system.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

SysConfigDataModel

Responses

[200] Success

[GET] /api/v1/sysconfig/icon

Get system icon.

Responses

[200] Success

[PUT] /api/v1/sysconfig/logo

Update the logo displayed in login page.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

SysConfigDataModel

Responses

[200] Success

[PUT] /api/v1/sysconfig/bgimage

Update the background image displayed in login page.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

SysConfigDataModel

Responses

[200] Success

[GET] /api/v1/sysconfig/passwordPolicy

Get password policy.

Responses

[200] Success

[PUT] /api/v1/sysconfig/passwordPolicy

Update password policy.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

SysConfigDataModel

Responses

[200] Success

[GET] /api/v1/sysconfig/lockedTime

Get locked time.

Responses

[200] Success

[PUT] /api/v1/sysconfig/lockedTime

Update locked time.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

SysConfigDataModel

Responses

[200] Success

[GET] /api/v1/sysconfig/global-organization

Get the global tenant setting.

Responses

[200] Success

[PUT] /api/v1/sysconfig/global-organization

Update the global tenant setting.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

GlobalTenantUpdateModel

Responses

[200] Success

[PUT] /api/v1/sysconfig/css

Update locked time.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

SysConfigDataModel

Responses

[200] Success

[PUT] /api/v1/sysconfig/html

Update locked time.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

SysConfigDataModel

Responses

[200] Success

[PUT] /api/v1/sysconfig/email-settings

Update email settings.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

EmailSettingSMTPSettings

Responses

[200] Success

[GET] /api/v1/sysconfig/security-settings

Get security related settings, include 'PasswordPolicy', 'LockedTime' and 'AllowUserResetPassword'.

Responses

[200] Success

[PUT] /api/v1/sysconfig/security-settings

Update security related settings, include 'PasswordPolicy', 'LockedTime' and 'AllowUserResetPassword'.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

SystemConfigSecuritySettings

Responses

[200] Success

Models

Ƭ SystemConfigBizModel

Name	Type	Description	Example
companyNameNullable	string	The system title.	"Wyn Enterprise"
sysIconNullable	string	The base64 string of the system icon.	"data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."
logoNullable	string	The base64 string of the logo in login page.	"data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."
bgImageNullable	string	The base64 string of the background image in login page.	"data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."
passwordPolicy	PasswordPolicy
lockedTimeNullable	int32	The locked time for multiple invalid login, in minutes.	60
loginPageTipNullable	string	The tip information in the login page.	"This is just a tip."
cssNullable	string	The custom CSS content.	"body { font-family: sans-serif; }"
htmlNullable	string	The custom HTML content.	"Custom HTML Content"
allowUserResetPasswordNullable	Boolean	Whether allow user to reset password.	true
showGlobalTenantNullable	Boolean	Whether show the "Global" organization when logging in.	true
defaultCookieLifetimeNullable	int32	The cookie expiration time for the users who didn't check the "remember me" option when logging in, in days.	0
cookieLifetimeForRememberLoginNullable	int32	The cookie expiration time for the users who checked the "remember me" option when logging in, in days.	14
forceChangePasswordOnFirstLoginNullable	Boolean	Whether force user to change password on first login.	false
forcePasswordExpirationNullable	Boolean	Whether force user to change password on password expiration.	false
passwordExpirationDaysNullable	int32	The password expiration days. The default value is 90 days.	90

Ƭ PasswordPolicy

Enum:

• WeakPasswordPolicy

• NormalPasswordPolicy

• StrongPasswordPolicy

  The password policy.

Ƭ SysConfigDataModel

Name	Type
dataNullable	string

Ƭ GlobalTenantUpdateModel

Name	Type
showGlobalTenant	Boolean

Ƭ EmailSettingSMTPSettings

Name	Type	Description	Example
serverAddressNullable	string	The SMTP server address.	"smtp.gmail.com"
serverPort	int32	The listening port of the SMTP service.	465
enableSSL	Boolean	Whether enable SSL protocol.	true
enableCertRevocationCheckNullable	Boolean	Whether check the certificate revocation status.	true
userNameNullable	string	The user name for logging in the SMTP service.	"example@gmail.com"
passwordNullable	string	The password of the user.	"MyPassword"
senderNameNullable	string	The display name of the email sender.	"MyDisplayName"
senderEmailNullable	string	The display email address of the email sender.	"example@gmail.com"
emailSenderType	EmailSenderType
googleClientIdNullable	string	The client id for of the Google mail service.	"your_client_id"
googleClientSecretNullable	string	The client secret of the Google mail service.	"your_client_secret"
googleTokensNullable	string	The generated token for sending email using Google mail service.	"generated_token"

Ƭ EmailSenderType

Enum:

• SMTP

• GoogleAPI

  The email sender type.

Ƭ SystemConfigSecuritySettings

Name	Type	Description	Example
passwordPolicy	PasswordPolicy
lockedTime	int32	The locked time, in minutes.	60
allowUserResetPassword	Boolean	Whether allow user to reset password.	false
defaultCookieLifetimeNullable	int32	The cookie expiration time for the users who didn't check the "remember me" option when logging in, in days.	0
cookieLifetimeForRememberLoginNullable	int32	The cookie expiration time for the users who checked the "remember me" option when logging in, in days.	14
forceChangePasswordOnFirstLogin	Boolean	Whether force user to change password on first login.	false
forcePasswordExpiration	Boolean	Whether force user to change password on password expiration.	false
passwordExpirationDaysNullable	int32	The password expiration days. The default value is 90 days.	90