Identity

[POST] /api/v2/identity/authorization-token

Create and save a new token.

Request Schema

any

Response

Status Code: 200

Success

AuthTokenResponseModel

Status Code: 400

Bad Request

ServerPluginError

[DELETE] /api/v2/identity/authorization-token/{authToken}

Delete specified authentication token and return this token info.

Parameters

Name	Type	Located In	Description
authTokenRequired	string	path	Authentication token which will be deleted.

Response

Status Code: 200

Success

AuthToken

Status Code: 400

Bad Request

ServerPluginError

[GET] /api/v2/identity/authorization-token/settings

Get authentication token settings.

Response

Status Code: 200

Success

TokenSettingsResponseModel

[PUT] /api/v2/identity/authorization-token/settings

Save authentication token settings.

Request Schema

TokenSettingsRequestModel

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ServerPluginError

[GET] /api/v2/identity/claim-mappings

Get all claim mappings.

Parameters

Name	Type	Located In	Description
onlyNames	Boolean	query	Whether only retrieve the claim names. For example: true

Response

Status Code: 200

Success

ClaimMappingModel

[POST] /api/v2/identity/claim-mappings

Add a new claim mapping.

Request Schema

ClaimMappingCreationModel

Response

Status Code: 201

Success

ClaimMappingModel

Status Code: 400

Bad Request

ApiErrorResult

[GET] /api/v2/identity/claim-mappings/{id}

Get the specified claim mapping.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The claim mapping id.

Response

Status Code: 200

Success

ClaimMappingModel

Status Code: 404

Not Found

ApiErrorResult

[PUT] /api/v2/identity/claim-mappings/{id}

Modify the specified claim mapping.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The claim mapping id.

Request Schema

ClaimMappingCreationModel

Response

Status Code: 200

Success

ClaimMappingModel

Status Code: 400

Bad Request

ApiErrorResult

Status Code: 404

Not Found

ApiErrorResult

[DELETE] /api/v2/identity/claim-mappings/{id}

Delete the specified claim mapping.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The claim mapping id.

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ApiErrorResult

Status Code: 404

Not Found

ApiErrorResult

[GET] /api/v2/identity/custom-properties

Get all customize properties.

Response

Status Code: 200

Success

CustomizePropertyBizModel

[POST] /api/v2/identity/custom-properties

Add a new customize property.

Request Schema

CustomPropertyCreationModel

Response

Status Code: 201

Success

CustomizePropertyBizModel

Status Code: 400

Bad Request

ApiErrorResult

[GET] /api/v2/identity/custom-properties/{id}

Get the specified customize property's information.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The custom property's id.

Response

Status Code: 200

Success

CustomizePropertyBizModel

Status Code: 404

Not Found

ApiErrorResult

[DELETE] /api/v2/identity/custom-properties/{id}

Delete the specified customize property.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The custom property id.

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ApiErrorResult

Status Code: 404

Not Found

ApiErrorResult

[PUT] /api/v2/identity/custom-properties/{id}

Update the specified customize property's information.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The custom property id.

Request Schema

CustomPropertyUpdateModel

Response

Status Code: 200

Success

CustomizePropertyBizModel

Status Code: 400

Bad Request

ApiErrorResult

Status Code: 404

Not Found

ApiErrorResult

[POST] /api/v2/identity/custom-properties/{id}/available-values-validation

Validate the new available values for the specified customize property.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The custom property id.

Request Schema

CustomPropertyAvailableValuesModel

Response

Status Code: 200

Success

CustomPropertyAvailableValuesValidationModel

Status Code: 400

Bad Request

ApiErrorResult

Status Code: 404

Not Found

ApiErrorResult

[GET] /api/v2/identity/permissions

Get all permissions.

Parameters

Name	Type	Located In	Description
enabled	Boolean	query	Whether only get the enabled permissions. For example: true

Response

Status Code: 200

Success

PermissionModel

[GET] /api/v2/identity/security-providers

Get all the security providers.

Parameters

Name	Type	Located In	Description
available	Boolean	query	Whether only get all the available security providers.

Response

Status Code: 200

Success

SecurityProviderModel

[PUT] /api/v2/identity/security-providers/{name}

Update the specified security provider's settings.

Parameters

Name	Type	Located In	Description
nameRequired	string	path	The security provider name.

Request Schema

SecurityProviderModel

Response

Status Code: 200

Success

SecurityProviderModel

Status Code: 400

Bad Request

ApiErrorResult

Status Code: 404

Not Found

ApiErrorResult

[DELETE] /api/v2/identity/security-providers/{name}

Delete the specified security provider.

Parameters

Name	Type	Located In	Description
nameRequired	string	path	The security provider name.

Response

Status Code: 204

Success

Status Code: 404

Not Found

ApiErrorResult

[POST] /api/v2/identity/security-providers/enable

Enable or disable the specified security providers.

Request Schema

SecurityProviderEnableModel

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ApiErrorResult

[POST] /api/v2/identity/security-providers/move

Update the ordinal of the specified security provider.

Request Schema

SecurityProviderMoveModel

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ApiErrorResult

Status Code: 404

Not Found

ApiErrorResult

[POST] /api/v2/identity/security-providers/reload

Reload all security providers.

Response

Status Code: 200

Success

SecurityProviderModel

[GET] /api/v2/identity/security-providers/export

Export security providers.

Response

Status Code: 200

Success

SecurityProviderModel

[POST] /api/v2/identity/security-providers/import

Import security providers.

Request Schema

SecurityProvidersImportModel

Response

Status Code: 200

Success

SecurityProviderModel

Status Code: 400

Bad Request

ApiErrorResult

[GET] /api/v2/identity/sys-config

Get the system configuration record.

Response

Status Code: 200

Success

SystemConfigModel

[PUT] /api/v2/identity/sys-config

Update the system configuration.

Request Schema

SystemConfigBizModel

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ApiErrorResult

Status Code: 404

Not Found

ApiErrorResult

[PUT] /api/v2/identity/sys-config/name

Update the company name.

Request Schema

data

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ApiErrorResult

[PUT] /api/v2/identity/sys-config/icon

Update the icon of the system.

Request Schema

data

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ApiErrorResult

[GET] /api/v2/identity/sys-config/icon

Get system icon.

Response

Status Code: 200

Success

byte

[PUT] /api/v2/identity/sys-config/logo

Update the logo displayed in login page.

Request Schema

data

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ApiErrorResult

[PUT] /api/v2/identity/sys-config/bgimage

Update the background image displayed in login page.

Request Schema

data

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ApiErrorResult

[GET] /api/v2/identity/sys-config/password-policy

Get the system password policy.

Response

Status Code: 200

Success

PasswordPolicyInfoModel

[PUT] /api/v2/identity/sys-config/password-policy

Update the system password policy.

Request Schema

data

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ApiErrorResult

[GET] /api/v2/identity/sys-config/locked-time

Get locked time.

Response

Status Code: 200

Success

int32

[PUT] /api/v2/identity/sys-config/locked-time

Update locked time.

Request Schema

int32

Response

Status Code: 204

Success

[GET] /api/v2/identity/sys-config/show-global-organization

Retrieve whether the global organization is enabled or not.

Response

Status Code: 200

Success

[PUT] /api/v2/identity/sys-config/css

Update the custom CSS content.

Request Schema

data

Response

Status Code: 204

Success

[PUT] /api/v2/identity/sys-config/html

Update the custom HTML content.

Request Schema

data

Response

Status Code: 204

Success

[GET] /api/v2/identity/sys-config/email-settings

Get the email settings.

Response

Status Code: 200

Success

EmailSettingSMTPSettings

Status Code: 404

Not Found

ApiErrorResult

[PUT] /api/v2/identity/sys-config/email-settings

Update email settings.

Request Schema

EmailSettingSMTPSettings

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ApiErrorResult

[GET] /api/v2/identity/sys-config/security-settings

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

Response

Status Code: 200

Success

SystemConfigSecuritySettings

[PUT] /api/v2/identity/sys-config/security-settings

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

Request Schema

SystemConfigSecuritySettings

Response

Status Code: 204

Success

Status Code: 400

Bad Request

ApiErrorResult

[POST] /api/v2/identity/sys-config/global-organization

Show/Hide the global organization.

Request Schema

boolean

Response

Status Code: 204

Success

Models

Ƭ AuthTokenResponseModel

Represent an authentication token response model.

Name	Type	Description	Example
authTokenNullable	string	Get or set authentication token.

Ƭ ServerPluginError

Server plugin error

Name	Type	Description	Example
codeNullable	string	error code
messageNullable	string	error message
contextNullable	string	error context
innerError	ServerPluginError

Ƭ AuthToken

Name	Type	Description	Example
authTokenKeyNullable	string
tokenNullable	string
cookieLifetime	int32

Ƭ TokenSettingsResponseModel

Get or set authentication token settings.

Name	Type	Description	Example
lifetimeNullable	int32	Get or set token lifetime.

Ƭ TokenSettingsRequestModel

Get or set authentication token settings model.

Name	Type	Description	Example
lifetimeNullable	int32	Get or set token lifetime. Unit: Second	3600

Ƭ ClaimMappingModel

Name	Type	Description	Example
idNullable	string
name	string
propName	string
isBuiltIn	Boolean

Ƭ ApiErrorResult

The model used to describe all the errors that occurred when processing a web request.

Name	Type	Description	Example
errorsNullable	ApiError	The errors list.

Ƭ ApiError

The model used to describe an error that occurred when processing a web request.

Name	Type	Description	Example
codeNullable	string	The unique identity of the error.
messageNullable	string	The description text of the error.
contextNullable	string	Some related context information of the error.

Ƭ ClaimMappingCreationModel

Name	Type	Description	Example
name	string	The claim name.	"gender"
propName	string	The custom property name.	"Gender"

Ƭ CustomizePropertyBizModel

Name	Type	Description	Example
idNullable	string
nameNullable	string
showInListNullable	Boolean
allowUserEditNullable	Boolean
multivaluedNullable	Boolean
showInProfileNullable	Boolean
availableValuesNullable	Array<string>

Ƭ CustomPropertyCreationModel

Name	Type	Description	Example
name	string	The custom property name.	"Gender"
showInListNullable	Boolean	Whether show the custom property in the user list.	true
allowUserEditNullable	Boolean	Whether allow the user to edit this custom property.	true
multivaluedNullable	Boolean	Whether this custom property is a multi-valued property.
showInProfileNullable	Boolean	Whether show this custom property in the user profile page.	true
availableValuesNullable	Array<string>	The available values of this custom property.	["male","female"]

Ƭ CustomPropertyUpdateModel

Name	Type	Description	Example
name	string	The custom property name.	"Gender"
showInListNullable	Boolean	Whether show the custom property in the user list.	true
allowUserEditNullable	Boolean	Whether allow the user to edit this custom property.	true
multivaluedNullable	Boolean	Whether this custom property is a multi-valued property.
showInProfileNullable	Boolean	Whether show this custom property in the user profile page.	true
availableValuesNullable	Array<string>	The available values of this custom property.	["male","female"]

Ƭ CustomPropertyAvailableValuesValidationModel

Name	Type	Description	Example
hasInvalidValues	Boolean	Whether there are some invalid values.
invalidValuesNullable	Array<string>	The invalid values list.

Ƭ CustomPropertyAvailableValuesModel

Name	Type	Description	Example
availableValues	Array<string>	The available values of the custom property.	["male","female"]

Ƭ PermissionModel

Name	Type	Description	Example
nameNullable	string
descriptionNullable	string
enabled	Boolean
order	int32
moduleNullable	string
categoryNullable	string
isCustomPermission	Boolean

Ƭ SecurityProviderModel

Name	Type	Description	Example
providerNameNullable	string	The name of the security provider.	"AD Security Provider"
descriptionNullable	string	The description text of the security provider.	"The built-in AD security provider."
ordinal	int32	The ordinal of the security provider.	1
enabled	Boolean	Whether the security provider is enabled.	true
settingsNullable	ConfigurationItem	The configuration items.

Ƭ ConfigurationItem

Name	Type	Description	Example
nameNullable	string
displayNameNullable	string
descriptionNullable	string
valueType	ConfigurationItemValueType
valueNullable	any
restriction	ConfigurationItemRestriction

Ƭ ConfigurationItemValueType

Enum:

• Text
• Boolean
• Number
• Password

The value type of the configuration item.

* Text - 0 - A normal string.
* Boolean - 1 - A boolean value.
* Number - 2 - A number.
* Password - 3 - A string used as a password.

Ƭ ConfigurationItemRestriction

Enum:

• Mandatory
• Optional

The restriction of the configuration item.

* Mandatory - 0 - Means that this configuration item is required.
* Optional - 1 - Means that this configuration item is optional.

Ƭ SecurityProviderEnableModel

Name	Type	Description	Example
providerNames	Array<string>	The provider names.	["AD Security Provider","LDAP Security Provider"]
enable	Boolean	True means enable, false means disable.	true

Ƭ SecurityProviderMoveModel

Name	Type	Description	Example
providerName	string	The name of the security provider.	"AD Security Provider"
offset	int32	The offset to the current order of the security provider, the negative number means to move up, and the positive number means to move down.	-1

Ƭ SecurityProvidersImportModel

Name	Type	Description	Example
securityProviders	SecurityProviderModel	The security providers list.

Ƭ SystemConfigModel

Name	Type	Description	Example
securitySettings	SystemConfigSecuritySettings
customView	SystemConfigCustomView
viewDecorations	SystemConfigViewDecorations
preferences	SystemConfigPreferences

Ƭ SystemConfigSecuritySettings

Name	Type	Description	Example
passwordPolicy	PasswordPolicy
lockedTime	int32	The locked time, in minutes.	60
allowUserResetPassword	Boolean	Whether allow user to reset password.
defaultCookieLifetimeNullable	int32	The cookie expiration time for the users who didn't check the "remember me" option when logging in, in days.
cookieLifetimeForRememberLoginNullable	int32	The cookie expiration time for the users who checked the "remember me" option when logging in, in days.	14

Ƭ SystemConfigCustomView

Name	Type	Description	Example
loginPageTipNullable	string
cssNullable	string
htmlNullable	string

Ƭ SystemConfigViewDecorations

Name	Type	Description	Example
logoNullable	string
bgImageNullable	string

Ƭ SystemConfigPreferences

Name	Type	Description	Example
companyNameNullable	string
sysIconNullable	string
showGlobalTenant	Boolean

Ƭ PasswordPolicy

Enum:

• WeakPasswordPolicy
• NormalPasswordPolicy
• StrongPasswordPolicy

The password policy.

* WeakPasswordPolicy - 0 - The weak password policy.
* NormalPasswordPolicy - 10 - The normal password policy.
* StrongPasswordPolicy - 20 - The strong password policy.

Ƭ 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.
cookieLifetimeForRememberLoginNullable	int32	The cookie expiration time for the users who checked the "remember me" option when logging in, in days.	14

Ƭ PasswordPolicyInfoModel

Name	Type	Description	Example
nameNullable	string	The name of the password policy.
value	int32	The represent value of the password policy.

Ƭ 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
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.

* SMTP - 0 - Use SMTP protocol to send email.
* GoogleAPI - 1 - Use Google API to send email.