User

[GET] /api/v1/users

Parameters

Name	In	Type	Description
PageSize	query	integer	The page size.
PageNumber	query	integer	The page number.
SearchText	query	string	The search text.
OrderBy	query	string	The ordered field.
OrderType	query		The order type, available values are "ASC" and "DESC".
Paging	query	boolean	Whether pagination or not.
SearchType	query		The search type, available values are "None" and "Count".

Get all users' information.

Responses

[200] Success

[POST] /api/v1/users

Add a new user.

Request Body

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

UserPostViewModel

Responses

[200] Success

[GET] /api/v1/localusers

Parameters

Name	In	Type	Description
PageSize	query	integer	The page size.
PageNumber	query	integer	The page number.
SearchText	query	string	The search text.
OrderBy	query	string	The ordered field.
OrderType	query		The order type, available values are "ASC" and "DESC".
Paging	query	boolean	Whether pagination or not.
SearchType	query		The search type, available values are "None" and "Count".

Get all local users.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Get user by id.

Responses

[200] Success

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

Parameters

Name	In	Type	Default
idRequired	path	string
ignoreRoles	query	boolean	false

Update user information.

Request Body

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

UserPostViewModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Remove a exist user.

Responses

[200] Success

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

Delete the specified users.

Request Body

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

BatchDeleteUsersModel

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Get a user's roles

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Enable/Disable user.

Request Body

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

boolean

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Change user password.

Request Body

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

password

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Check user password.

Request Body

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

password

Responses

[200] Success

[PUT] /api/v1/users/changepassword

Change user password.

Request Body

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

ChangePasswordModel

Responses

[200] Success

[POST] /api/v1/users/import

Import users.

Responses

[200] Success

[GET] /api/v1/users/export

Export all users' information.

Responses

[200] Success

[GET] /api/v1/users/template

Export user information template.

Responses

[200] Success

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

Parameters

Name	In	Type	Description
keyRequired	path	string	The key of user template file.

Get the user template file to check the detailed error information.

Responses

[200] Success

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

Parameters

Name	In	Type	Description
keyRequired	path	string	The key of user template file.

Remove the useless user template file.

Responses

[200] Success

[GET] /api/v1/users/locked

Get locked users.

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Unlock user by id.

Responses

[200] Success

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

Reset the password of user 'Admin'.

Request Body

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

ResetAdminPasswordBizModel

Responses

[200] Success

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

Get available user context.

Responses

[200] Success

[GET] /api/v1/users/me

Get current user's claims.

Responses

[200] Success

[PUT] /api/v1/users/avatar

Add or update the user avatar.

Responses

[200] Success

[GET] /api/v1/users/profile

Get current user profile info.

Responses

[200] Success

[PUT] /api/v1/users/profile

Update current user profile info.

Request Body

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

UserProfileRequestModel

Responses

[200] Success

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

Get the roles that the current logged in user can share documents to.

Responses

[200] Success

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

Parameters

Name	In	Type	Description
idRequired	path	string	User id.

Get the permissions of the specified user.

Responses

[200] Success

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

Parameters

Name	In	Type	Description
nameRequired	path	string	User name.

Get all the permissions of the specified user.

Responses

[200] Success

[GET] /api/v1/users/organizations

Get all the organizations the current user belongs to.

Responses

[200] Success

[POST] /api/v1/users/organizations

Request Body

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

GetUserTenantModel

Responses

[200] Success

[GET] /api/v1/users/tenants

Get all the organizations the current user belongs to.

Responses

[200] Success

[POST] /api/v1/users/tenants

Request Body

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

GetUserTenantModel

Responses

[200] Success

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

Switch the organization to which the currently logged-in user belongs.

Request Body

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

SwitchTenantModel

Responses

[200] Success

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

Switch the organization to which the currently logged-in user belongs.

Request Body

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

SwitchTenantModel

Responses

[200] Success

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

Get all the users that do not belong to any organization.

Responses

[200] Success

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

Get all the users that do not belong to any organization.

Responses

[200] Success

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

Set the default tenant which the user can directly log in to.

Request Body

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

SwitchTenantModel

Responses

[200] Success

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

Responses

[200] Success

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

Set the default tenant which the user can directly log in to.

Request Body

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

SwitchTenantModel

Responses

[200] Success

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

Responses

[200] Success

Models

Ƭ OrderType

Enum:

• ASC

• DESC

  The order type.

Ƭ SearchType

Enum:

• None

• Count

  The search type for searching records.

Ƭ UserPostViewModel

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

Ƭ UserPasswordExpirationPolicy

Enum:

• FollowSystem
• NeverExpire

Ƭ BatchDeleteUsersModel

Name	Type
userIdsNullable	Array<string>

Ƭ ChangePasswordModel

Name	Type
oldPasswordNullable	string
newPasswordNullable	string
newPasswordConfirmNullable	string

Ƭ ResetAdminPasswordBizModel

Name	Type
tokenNullable	string
passwordNullable	string

Ƭ UserProfileRequestModel

Name	Type
firstNameNullable	string
lastNameNullable	string
fullNameNullable	string
mobileNullable	string
customizePropertyInfoNullable	Array<string>

Ƭ GetUserTenantModel

Name	Type
userNameNullable	string
passwordNullable	string

Ƭ SwitchTenantModel

Name	Type
tenantIdNullable	string