User

用户(User)

[PUT] /api/v2/common/users/{id}/homepage

设置用户主页文档id

参数

名称	类型	位置	描述
id必填项	string	path

请求模式

HomePageV2Controller+SetUserHomePageRequestModel

响应

状态代码: 204

成功

状态代码: 400

错误请求

ServerPluginError

[GET] /api/v2/identity/users

获取所有用户的信息

参数

名称	类型	位置	描述	示例
Provider	string	query	用户提供程序名称	`"local"`
PageSize	int32	query	每页查询用户数量	`20`
PageNumber	int32	query	当前查询的页号	`1`
SearchText	string	query	查找的文本	`"admin"`
OrderBy	string	query	排序列名称	`"UserName"`
OrderType	OrderType	query	排序方式，可用的排序包括 "ASC" 和 "DESC".	`"ASC"`
Paging	Boolean	query	是否进行分页查询	`true`
SearchType	SearchType	query	查找的方式，可用的方式包括 "None" 和 "Count".	`"None"`

响应

状态代码: 200

成功

GrapeCity.Enterprise.Identity.Models.ModelSearchResponse`1[[GrapeCity.Enterprise.Identity.Database.Models.UserBizModel, GrapeCity.Enterprise.IdentityService, Version=6.1.39.0, Culture=neutral, PublicKeyToken=null]]

[POST] /api/v2/identity/users

创建一个新用户

请求模型

UserCreationModel

响应

状态代码: 201

成功

UserBizModel

状态代码: 400

错误请求

ApiErrorResult

状态代码: 403

禁止

ApiErrorResult

[GET] /api/v2/identity/users/{id}

通过id获取用户信息。

参数

名称	类型	位置	描述
id必填项	string	path	用户id。

响应

状态代码: 200

成功

UserBizModel

状态代码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/users/{id}

更新用户信息。

参数

名称	类型	位置	描述
id必填项	string	path	用户id。
ignoreRoles	Boolean	query	是否忽略用户角色。

请求模型

UserUpdateModel

响应

状态代码: 200

成功

UserBizModel

状态代码: 400

错误请求

ApiErrorResult

状态代码: 403

禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/users/{id}

删除现有用户。

参数

名称	类型	位置	描述
id必填项	string	path	用户id。

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

状态代码: 403

禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/users/batch-delete

删除指定用户。

请求模型

BatchDeleteUsersModel

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

状态代码: 403

禁止

ApiErrorResult

[GET] /api/v2/identity/users/{id}/roles

获取用户的角色。

参数

名称	类型	位置	描述
id必填项	string	path	用户id。

响应

状态代码: 200

成功

Array<string>

状态代码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/users/{id}/enable

启用/禁用用户。

参数

名称	类型	位置	描述
id必填项	string	path	用户id。

请求模型

boolean

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

状态代码: 403

禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/users/{id}/password

更改指定用户的密码。

参数

名称	类型	位置	描述
id必填项	string	path	用户id。

请求模型

password

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

状态代码: 403

禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/users/change-password

更改用户密码。

请求模型

ChangePasswordModel

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/users/import

导入用户。

响应

状态代码: 200

成功

ImportUserResult

[GET] /api/v2/identity/users/export

导出所有用户信息。

响应

状态代码: 200

成功

二进制

[GET] /api/v2/identity/users/template

导出用户信息模板。

响应

状态代码: 200

成功

二进制

[GET] /api/v2/identity/users/template/{key}

获取用户导入结果文件，查看详细错误信息。

参数

名称	类型	位置	描述
key必填项	string	path	用户模板文件的key。

响应

状态代码: 200

成功

二进制

状态代码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/users/template/{key}

删除无用的用户模板文件。

参数

名称	类型	位置	描述
key必填项	string	path	用户模板文件的key。

响应

状态代码: 204

成功

状态代码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/users/locked

获取锁定用户。

响应

状态代码: 200

成功

LockedUserModel

[POST] /api/v2/identity/users/{id}/unlock

通过 id 解锁用户。

参数

名称	类型	位置	描述
id必填项	string	path	用户id。

响应

状态代码: 204

成功

[POST] /api/v2/identity/users/reset-password

重置用户“admin”的密码。

请求模型

ResetAdminPasswordModel

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

[GET] /api/v2/identity/users/available-context

获取可用的用户上下文。

响应

状态代码: 200

成功

UserContextItem

[GET] /api/v2/identity/users/me

获取当前用户的声明。

响应

状态代码: 200

成功

SimpleClaimModel

[GET] /api/v2/identity/users/{id}/avatar

获取指定用户的头像。

参数

名称	类型	位置	描述
id必填项	string	path	用户id。

响应

状态代码: 200

成功

二进制

状态代码: 304

未修改

[PUT] /api/v2/identity/users/avatar

添加或更新当前用户的头像。

请求模型

二进制

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

[GET] /api/v2/identity/users/profile

获取当前用户的个人资料信息。

响应

状态代码: 200

成功

UserProfileRequestModel

状态代码: 400

错误请求

ApiErrorResult

[PUT] /api/v2/identity/users/profile

更新当前用户的个人资料信息。

请求模型

UserProfileRequestModel

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

[GET] /api/v2/identity/users/me/sharing-roles

获取当前登录用户可以共享文档的角色。

响应

状态代码: 200

成功

SharingRoleModel

[GET] /api/v2/identity/users/{id}/permissions

获取指定用户的权限。

参数

名称	类型	位置	描述
id必填项	string	path	用户id。

响应

状态代码: 200

成功

Array<string>

状态代码: 400

错误请求

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

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

获取指定用户的所有权限。

参数

名称	类型	位置	描述
name必填项	string	path	用户名

响应

状态代码: 200

成功

Array<string>

状态代码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/users/organizations

获取当前用户所属的所有组织。

响应

状态代码: 200

成功

UserTenantBizModel

[GET] /api/v2/identity/users/non-org-users

获取不属于任何组织的所有用户。

响应

状态代码: 200

成功

UserBizModel

[POST] /api/v2/identity/users/default-organization

设置用户可以直接登录的默认组织。

请求模型

organizationId

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/users/default-organization

删除当前用户的默认组织设置。

响应

状态代码: 204

成功

模型定义

Ƭ ServerPluginError

服务器插件错误

名称	类型	描述
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	ServerPluginError

Ƭ HomePageV2Controller+SetUserHomePageRequestModel

设置用户主页请求模型

名称	类型	描述	示例
userId可为空	string	用户名	`"160C30CC-B9FF-43F8-852A-3BD672176C4B"`
userHomeDocumentId可为空	string	用户主页文档id	`"8760F2A1-C217-480F-8EB0-1EE9DB3AE2C5"`

Ƭ OrderType

Enum:

ASC
DESC

订单类型。

* ASC - 0 - 升序。
* DESC - 1 - 降序。

Ƭ SearchType

Enum:

None
Count

搜索记录的搜索类型。

* None - 0 - 正常搜索。
* Count - 1 - 只检索记录数。

Ƭ GrapeCity.Enterprise.Identity.Models.ModelSearchResponse`1[[GrapeCity.Enterprise.Identity.Database.Models.UserBizModel, GrapeCity.Enterprise.IdentityService, Version=6.1.39.0, Culture=neutral, PublicKeyToken=null]]

名称	类型	描述	示例
models可为空	UserBizModel
total	int32
pageSize可为空	int32	页面大小。	`20`
pageNumber可为空	int32	页码。	`1`
searchText可为空	string	搜索文本。	`"admin"`
orderBy可为空	string	有序字段。	`"UserName"`
orderType	OrderType
paging可为空	Boolean	是否分页。	`true`
searchType	SearchType

Ƭ UserBizModel

名称	类型	描述	示例
id可为空	string
username可为空	string
email可为空	string
mobile可为空	string
provider可为空	string
avatar可为空	string
firstName可为空	string
lastName可为空	string
creationTime	ISO DateTime Sting
status	UserStatus
fullName可为空	string
organizationIdPath可为空	string
roles可为空	`Array<string>`
customizeProperties可为空	`Array<string>`
extraClaims可为空	string
tenantRoles可为空	`Array<string>`

Ƭ UserStatus

Enum:

Normal
Disabled

用户的状态。

* Normal - 1 - 正常状态。
* Disabled - 2 - 禁用状态。

Ƭ ApiErrorResult

该模型用于描述处理 Web 请求时发生的所有错误。

名称	类型	描述	示例
errors可为空	ApiError	错误列表。

Ƭ ApiError

该模型用于描述处理 Web 请求时发生的错误。

名称	类型	描述
code可为空	string	错误的唯一标识。
message可为空	string	错误的描述文本。
context可为空	string	错误的一些相关上下文信息。

Ƭ UserCreationModel

名称	类型	描述	示例
id可为空	string	用户 ID，可以为空。	`"8760F2A1-C217-480F-8EB0-1EE9DB3AE2C5"`
username	string	用户名为必填项，而且不能被修改	`"MyUserName"`
firstName可为空	string	用户的名字。	`"MyFirstName"`
lastName可为空	string	用户的姓氏。	`"MyLastName"`
fullName可为空	string	用户的全名。	`"MyFullName"`
email	string	用户邮箱地址为必填项	`"example@gmail.com"`
mobile可为空	string	手机号码。	`"88888888888"`
password可为空	string	用户密码。	`"MyPassword"`
provider可为空	string	用户提供程序，默认值为本地。	`"local"`
enabled	Boolean	该用户是否被禁用	`true`
organizationId可为空	string	用户所在的组织 ID。	`"D6F4019D-54FB-4B30-AA84-424010ABA3C5"`
managerId可为空	string	可以管理用户的组织id。	`"14A7B860-32A4-4F2B-BFC2-C511F45022C2"`
roles可为空	`Array<string>`	用户所属的角色。	`["ReportDesigner","DataManager"]`
customProperties可为空	`Array<string>`	自定义属性。	`{"Gender":["male"],"ExternalRoles":["DBA","Support"]}`

Ƭ UserUpdateModel

名称	类型	描述	示例
firstName可为空	string	用户的名字。	`"MyFirstName"`
lastName可为空	string	用户的姓氏。	`"MyLastName"`
fullName可为空	string	用户的全名。	`"MyFullName"`
email	string	用户邮箱地址为必填项	`"example@gmail.com"`
mobile可为空	string	用户的手机号码。	`"88888888888"`
password可为空	string	用户密码，null表示不修改原密码。	`"MyNewPassword"`
enabled	Boolean	该用户是否被禁用	`true`
organizationId可为空	string	用户所在的组织 ID。	`"DD6DAFF7-6789-46E3-9294-C4D74542D971"`
managerId可为空	string	可以管理用户的组织id。	`"4DBED725-F4AB-4EC6-AD28-C164613FE294"`
roles可为空	`Array<string>`	用户所属的角色。	`["ReportDesigner","DataManager"]`
customProperties可为空	`Array<string>`	自定义属性。	`{"Gender":["male"],"ExternalRoles":["DBA","Support"]}`

Ƭ BatchDeleteUsersModel

名称	类型	描述	示例
userIds	`Array<string>`	用户 ID 列表。	`["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"]`

Ƭ ChangePasswordModel

名称	类型	描述	示例
oldPassword	string	旧密码。	`"OldPassword"`
newPassword	string	新密码。	`"NewPassword"`
newPasswordConfirm	string	确认密码。	`"NewPassword"`

Ƭ ImportUserResult

名称	类型	描述
importedUserCount	int32	导入成功的用户数。
notImportedUserCount	int32	导入失败的用户数。
detailKey可为空	string	用于检索有关导入错误的详细信息的唯一键。
errorMsg可为空	string	错误信息。

Ƭ LockedUserModel

名称	类型	描述	示例
id可为空	string
username可为空	string
provider可为空	string

Ƭ ResetAdminPasswordModel

名称	类型	描述	示例
token	string	请求令牌（Token）	`"A4CDF5CD-29D2-41DF-A02E-3C5492F6FC2B"`
password	string	新密码	`"NewPassword"`

Ƭ UserContextItem

名称	类型	描述
name可为空	string	用户上下文名称。
isBuiltIn	Boolean	它是否是内置的用户上下文。
multivalued	Boolean	是否为多值用户上下文。

Ƭ SimpleClaimModel

名称	类型	描述	示例
type可为空	string	声明类型。
value可为空	string	声明值。

Ƭ UserProfileRequestModel

名称	类型	描述	示例
firstName可为空	string	名字。	`"MyFirstName"`
lastName可为空	string	姓氏。	`"MyLastName"`
fullName可为空	string	全名。	`"MyFullName"`
email	string	用户邮箱地址	`"example@gmail.com"`
mobile可为空	string	手机号码。	`"88888888888"`
customProperties可为空	`Array<string>`	自定义属性。	`{"Gender":["male"],"ExternalRoles":["DBA","Support"]}`

Ƭ SharingRoleModel

名称	类型	描述
id可为空	string	角色id。
name可为空	string	角色名称。
tenantId可为空	string	组织 ID。
isBuiltIn	Boolean	是否是内置角色。
permissions可为空	`Array<string>`	角色的权限。

Ƭ UserTenantBizModel

名称	类型	描述
id可为空	string	组织标识。
name可为空	string	组织名称。
path可为空	string	组织路径。
isDefault	Boolean	该组织是否为当前用户设定的默认组织