User

[GET] /api/v1/users

Get all the users' information.

Parameters

Name	Type	Located In	Description
PageSize	int32	query	The page size.
PageNumber	int32	query	The page number.
SearchText	string	query	The search text.
OrderBy	string	query	The order by info.
OrderType	OrderType	query	The order type info.
Paging	Boolean	query	The paging info.
SearchType	SearchType	query	The search type info.

Response

Status Code: 200

Success

[POST] /api/v1/users

Add a new user.

Request Schema

UserPostViewModel

Response

Status Code: 200

Success

[GET] /api/v1/localusers

Get all the local users' information.

Parameters

Name	Type	Located In	Description
PageSize	int32	query	The page size.
PageNumber	int32	query	The page number.
SearchText	string	query	The search text.
OrderBy	string	query	The order by info.
OrderType	OrderType	query	The order type info.
Paging	Boolean	query	The paging info.
SearchType	SearchType	query	The search type info.

Response

Status Code: 200

Success

[GET] /api/v1/users/{id}

Get the specified user's information.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The user id.

Response

Status Code: 200

Success

[PUT] /api/v1/users/{id}

Update the specified user.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The user id.
ignoreRoles	Boolean	query

Request Schema

UserPostViewModel

Response

Status Code: 200

Success

[DELETE] /api/v1/users/{id}

Delete the specified user.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The user id.

Response

Status Code: 200

Success

[POST] /api/v1/users/batch-delete

Delete the specified users.

Request Schema

BatchDeleteUsersModel

Response

Status Code: 200

Success

[GET] /api/v1/users/{id}/roles

Get the roles assigned to the specified user.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The user id.

Response

Status Code: 200

Success

[PUT] /api/v1/users/{id}/enable

Enable or disable the specified user.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The user id.

Request Schema

boolean

Response

Status Code: 200

Success

[PUT] /api/v1/users/{id}/password

Change specified user's password.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The user id.

Response

Status Code: 200

Success

[POST] /api/v1/users/{id}/password

Verify the password of the specified user.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The user id.

Response

Status Code: 200

Success

[PUT] /api/v1/users/changepassword

Change current user's password.

Request Schema

ChangePasswordModel

Response

Status Code: 200

Success

[POST] /api/v1/users/import

Import specified users.

Response

Status Code: 200

Success

[GET] /api/v1/users/export

Export all the users to an Excel file.

Response

Status Code: 200

Success

[GET] /api/v1/users/template

Get the template for importing users.

Response

Status Code: 200

Success

[GET] /api/v1/users/template/{key}

Get the Excel file which indicates the error information on why importing users failed.

Parameters

Name	Type	Located In	Description
keyRequired	string	path	The key.

Response

Status Code: 200

Success

[DELETE] /api/v1/users/template/{key}

Delete the specified Excel file store in memory which indicates the error information why importing users failed.

Parameters

Name	Type	Located In	Description
keyRequired	string	path	The key.

Response

Status Code: 200

Success

[GET] /api/v1/users/locked

Get the locked users.

Response

Status Code: 200

Success

[POST] /api/v1/users/{id}/unlock

Unlock the specified user.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The user id.

Response

Status Code: 200

Success

[POST] /api/v1/users/reset-password

Reset the admin's password.

Request Schema

ResetAdminPasswordBizModel

Response

Status Code: 200

Success

[GET] /api/v1/users/available-context

Get the available user context.

Response

Status Code: 200

Success

[GET] /api/v1/users/me

Get all the claims of current user.

Response

Status Code: 200

Success

[PUT] /api/v1/users/avatar

Update current user's avatar.

Response

Status Code: 200

Success

[GET] /api/v1/users/profile

Get current user's profile information.

Response

Status Code: 200

Success

[PUT] /api/v1/users/profile

Update current user's profile information.

Request Schema

UserProfileRequestModel

Response

Status Code: 200

Success

[GET] /api/v1/users/me/sharing-roles

Get the roles assigned to the specified user.

Response

Status Code: 200

Success

[GET] /api/v1/users/{id}/permissions

Get the permissions of the specified user.

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

[GET] /api/v1/users/{name}/permissions-by-name

Get the permissions assigned to the specified user.

Parameters

Name	Type	Located In
nameRequired	string	path

Response

Status Code: 200

Success

[GET] /api/v1/users/organizations

Get the organizations that the current logged in user belongs to.

Response

Status Code: 200

Success

[POST] /api/v1/users/organizations

Update the organizations that the current logged in user belongs to.

Request Schema

GetUserTenantModel

Response

Status Code: 200

Success

[GET] /api/v1/users/tenants

Get the tenants that the current logged in user belongs to.

Response

Status Code: 200

Success

[POST] /api/v1/users/tenants

Update the tenants that the current logged in user belongs to.

Request Schema

GetUserTenantModel

Response

Status Code: 200

Success

[POST] /api/v1/users/switch-organization

Switch organization for a specified user.

Request Schema

SwitchTenantModel

Response

Status Code: 200

Success

[POST] /api/v1/users/switch-tenant

Switch tenant of the specified user.

Request Schema

SwitchTenantModel

Response

Status Code: 200

Success

[GET] /api/v1/users/non-org-users

Get the users who do not belong to any organization.

Response

Status Code: 200

Success

[GET] /api/v1/users/non-tenant-users

Get the users who do not belong to any tenant.

Response

Status Code: 200

Success

[POST] /api/v1/users/default-org

The default organization of the current logged in user.

Request Schema

SwitchTenantModel

Response

Status Code: 200

Success

[DELETE] /api/v1/users/default-org

Deletes the default organization of the current logged in user.

Response

Status Code: 200

Success

[POST] /api/v1/users/default-tenant

The default tenant of the current logged in user.

Request Schema

SwitchTenantModel

Response

Status Code: 200

Success

[DELETE] /api/v1/users/default-tenant

Delete the default organization of the current logged in user.

Response

Status Code: 200

Success

Models

Ƭ OrderType

Enum:

• ASC
• DESC

Ƭ SearchType

Enum:

• None
• Count

Ƭ UserPostViewModel

Name	Type	Description	Example
idNullable	string
usernameNullable	string
firstNameNullable	string
lastNameNullable	string
fullNameNullable	string
emailNullable	string
mobileNullable	string
passwordNullable	string
providerNullable	string
enabled	Boolean
tenantIdNullable	string
managerIdNullable	string
rolesNullable	Array<string>
customizePropertyInfoNullable	Array<string>

Ƭ BatchDeleteUsersModel

Name	Type	Description	Example
userIdsNullable	Array<string>

Ƭ ChangePasswordModel

Name	Type	Description	Example
oldPasswordNullable	string
newPasswordNullable	string
newPasswordConfirmNullable	string

Ƭ ResetAdminPasswordBizModel

Name	Type	Description	Example
tokenNullable	string
passwordNullable	string

Ƭ UserProfileRequestModel

Name	Type	Description	Example
firstNameNullable	string
lastNameNullable	string
fullNameNullable	string
emailNullable	string
mobileNullable	string
customizePropertyInfoNullable	Array<string>

Ƭ GetUserTenantModel

Name	Type	Description	Example
userNameNullable	string
passwordNullable	string

Ƭ SwitchTenantModel

Name	Type	Description	Example
tenantIdNullable	string