Identity-Organization

[GET] /api/v2/identity/organizations

获取所有组织的信息。

参数:

名称	类型	位置	描述
includeProps	Boolean	query	是否检索组织属性。例如：false

返回值

状态码: 200

成功

TenantBizModel

状态码: 403

禁止

ApiErrorResult

[POST] /api/v2/identity/organizations

添加新组织。

请求数据格式

TenantCreateModel

返回值

状态码: 201

已创建

TenantBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

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

获取指定组织的信息。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。

返回值

状态码: 200

成功

TenantBizModel

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

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

修改指定组织的信息。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。

请求数据格式

TenantUpdateModel

返回值

状态码: 200

成功

TenantBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

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

删除指定组织。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。

返回值

状态码: 204

无内容

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/sub-organizations

获取指定组织的所有子组织。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。
includeSelf	Boolean	query	是否检索指定组织的信息。例如：false

返回值

状态码: 200

成功

TenantBizModel

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/ancestor-organizations

获取指定组织的所有祖先组织。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。

返回值

状态码: 200

成功

TenantBizModel

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

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

获取属于指定组织的用户。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。
includeSubOrganizationUsers	Boolean	query	是否检索子组织的用户。例如：false

返回值

状态码: 200

成功

UserBizModel

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

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

将用户添加到指定组织。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。

请求数据格式

UserListModel

返回值

状态码: 200

成功

UserBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

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

更新属于指定组织的用户。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。

请求数据格式

UserListModel

返回值

状态码: 200

成功

UserBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

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

从指定组织中删除指定用户。

参数:

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

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/non-org-users

获取不属于指定组织的用户。

参数:

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

返回值

状态码: 200

成功

UserBizModel

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

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

获取指定组织的所有角色。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。
includeSubOrgRoles	Boolean	query	是否检索所有子组织的角色。例如：false

返回值

状态码: 200

成功

RoleBizModel

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/organizations/{id}/roles

将新角色添加到指定组织。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。

返回值

状态码: 201

已创建

RoleBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/organizations/{id}/roles/{roleId}

更新组织的角色。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。
roleId必填项	string	path	组织角色ID。

请求数据格式

RoleUpdateModel

返回值

状态码: 200

成功

RoleBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/roles/{roleId}

获取指定租户的角色。

参数:

名称	类型	位置	描述
id必填项	string	path	租户 ID。
roleId必填项	string	path	角色 ID。

返回值

状态码: 200

成功

RoleBizModel

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/organizations/{id}/roles/{roleId}

从指定租户中删除指定角色。

参数:

名称	类型	位置	描述
id必填项	string	path	租户 ID。
roleId必填项	string	path	角色 ID。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

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

获取属于指定组织角色的用户。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。
roleId必填项	string	path	角色 ID。

返回值

状态码: 200

成功

UserBizModel

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/organizations/{id}/roles/{roleId}/users

将用户添加到指定的组织角色。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。
roleId必填项	string	path	角色 ID。

请求数据格式

UserListModel

返回值

状态码: 200

成功

UserBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/organizations/{id}/roles/{roleId}/users

更新指定组织角色的用户。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。
roleId必填项	string	path	角色 ID。

请求数据格式

UserListModel

返回值

状态码: 200

成功

UserBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/organizations/{id}/roles/{roleId}/users/{userId}

从指定的组织角色中删除用户。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。
roleId必填项	string	path	角色 ID。
userId必填项	string	path	用户 ID。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/roles/{roleId}/permissions

获取指定组织角色的权限。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。
roleId必填项	string	path	角色 ID。

返回值

状态码: 200

成功

PermissionModel

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/organizations/{id}/roles/{roleId}/permissions

更新指定组织角色的权限。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。
roleId必填项	string	path	角色 ID。

请求数据格式

PermissionListModel

返回值

状态码: 200

成功

PermissionModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

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

获取指定组织的权限。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。

返回值

状态码: 200

成功

PermissionModel

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/organizations/{id}/permissions

更新指定组织的权限。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。

请求数据格式

PermissionListModel

返回值

状态码: 200

成功

PermissionModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

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

获取所有组织属性。

参数:

名称	类型	位置
includeBuiltInProps	Boolean	query

返回值

状态码: 200

成功

TenantPropModel

[POST] /api/v2/identity/organizations/props

添加新的组织属性。

请求数据格式

TenantPropInfoModel

返回值

状态码: 201

已创建

TenantPropModel

状态码: 400

错误的请求

ApiErrorResult

[GET] /api/v2/identity/organizations/props/{propId}

获取指定组织属性的信息。

参数:

名称	类型	位置	描述
propId必填项	string	path	组织属性 ID。

返回值

状态码: 200

成功

TenantPropModel

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/organizations/props/{propId}

修改指定的组织属性。

参数:

名称	类型	位置	描述
propId必填项	string	path	组织属性 ID。

请求数据格式

TenantPropInfoModel

返回值

状态码: 200

成功

TenantPropModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/organizations/props/{propId}

删除指定的组织属性。

参数:

名称	类型	位置	描述
propId必填项	string	path	组织属性 ID。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/organizations/{id}/move

修改指定组织的顺序。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。

请求数据格式

int32

返回值

状态码: 204

无内容

状态码: 403

禁止

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/organizations/{id}/migrate

迁移指定组织。

参数:

名称	类型	位置	描述
id必填项	string	path	组织 ID。

请求数据格式

OrganizationMigrationModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

类型定义

Ƭ TenantBizModel

名称	类型	描述	示例
id可为空	string
name可为空	string
description可为空	string
enabled	Boolean
path可为空	string
parentTenantId可为空	string
order	int32
createTime	ISO DateTime Sting
props可为空	TenantPropValueBizModel

Ƭ TenantPropValueBizModel

名称	类型	描述	示例
id可为空	string	组织属性值的唯一标识。	"393B6B48-4C8B-4B0F-9175-A01177CBD328"
allowSubTenantEditing	Boolean	是否允许下级组织编辑该属性值。	true
editable	Boolean	属性值是否可编辑。	true
allowSubTenantViewing	Boolean	是否允许下级组织查看该属性值。	true
viewable	Boolean	属性值是否可见。	true
values可为空	Array<string>	属性值。	["value1","value2","value3"]
name	string	组织属性名称。	"OrganizationAddress"
description可为空	string	组织属性的描述文本。	"The address of the organization."
required	Boolean	属性是否为必填项。	true
valueType	PropertyValueType
multivalued	Boolean	属性是否可以有多个值。	true
sensitive	Boolean	属性是否大小写敏感。

Ƭ PropertyValueType

Enum:

• Text
• Boolean
• Integer
• Float
• Date
• DateTime

组织属性的值类型。

* text - 0 - 普通字符串。
* boolean - 1 - 布尔值。
* integer - 2 - 整数。
* float - 3 - 浮点数。
* date - 4 - 日期
* datetime - 5 - 日期时间

Ƭ ApiErrorResult

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

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

Ƭ ApiError

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

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

Ƭ TenantCreateModel

名称	类型	描述	示例
parentTenantId可为空	string	父组织id，null表示在“全局”组织下创建组织。	"3FEF2BB9-4D25-47AA-8196-928CEC86A7C6"
name可为空	string	组织名称。	"GrapeCity"
description可为空	string	组织的描述文本。	"This is a sample organization."
props可为空	TenantPropValueBizModel	租户的属性。

Ƭ TenantUpdateModel

名称	类型	描述	示例
name可为空	string	组织名称。	"GrapeCity"
description可为空	string	组织的描述文本。	"This is a sample organization."
props可为空	TenantPropValueBizModel	租户的属性。

Ƭ 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
lastLoginTime可为空	ISO DateTime Sting
passwordChangeTime可为空	ISO DateTime Sting
passwordExpirationPolicy	UserPasswordExpirationPolicy
roles可为空	Array<string>
customizeProperties可为空	Array<string>
extraClaims可为空	string
tenantRoles可为空	Array<string>

Ƭ UserStatus

Enum:

• Normal
• Disabled

用户的状态。

* normal - 1 - 正常状态。
* disabled - 2 - 禁用状态。

Ƭ UserPasswordExpirationPolicy

Enum:

• FollowSystem
• NeverExpire

Ƭ UserListModel

名称	类型	描述	示例
userIds	Array<string>	用户 ID 列表。	["5A0E8745-A515-42E3-B225-F7DDE06B5632","9B987F4B-894C-48CC-836F-D67522B0A680"]

Ƭ RoleBizModel

名称	类型	描述	示例
id可为空	string	角色的独特身份。	"972B2A4C-8C61-4E3B-AD3D-6E889FE8D761"
name可为空	string	角色的显示名称。	"DataManager"
creatorId可为空	string	角色的创建者 ID。	"CF61388C-D7CD-4A61-8FB3-A8A0B6915F3E"
createTime	ISO DateTime Sting	角色的创建时间。	"2000-01-01T00:00:00.0000000+08:00"
isBuiltin	Boolean	是否是内置角色。
allowEditPermissions	Boolean	是否允许编辑角色的权限。	true
permissions可为空	Array<string>	角色的权限。	["view-report","view-dashboard"]
members可为空	Array<string>	角色的成员id列表。	["CD079B35-4A56-4F42-845D-726B09E08EA9","EAAA677A-7B0A-4471-99F0-4C3F1D31738C"]
tenantId可为空	string	角色所属组织的 ID。	"D6FD678D-45B5-4222-BA81-58BE2E578F91"
modifiedBy可为空	string	角色的修改者ID。	"CF61388C-D7CD-4A61-8FB3-A8A0B6915F3E"
modifiedTime	ISO DateTime Sting	角色的修改时间。	"2000-01-01T00:00:00.0000000+08:00"

Ƭ RoleUpdateModel

名称	类型	描述	示例
name可为空	string

Ƭ PermissionModel

名称	类型	描述	示例
name可为空	string
description可为空	string
enabled	Boolean
order	int32
module可为空	string
category可为空	string
isCustomPermission	Boolean

Ƭ PermissionListModel

名称	类型	描述	示例
permissions	Array<string>	权限列表。	["view-dashboard","view-report"]

Ƭ TenantPropModel

名称	类型	描述	示例
id可为空	string
name	string
description可为空	string
required	Boolean
valueType	PropertyValueType
multivalued	Boolean
sensitive	Boolean
tenantpropRestrictions可为空	TenantPropRestrictionModel
tenantPropValues可为空	TenantPropValueModel

Ƭ TenantPropRestrictionModel

名称	类型	描述	示例
tenantId	string
tenantPropId	string
allowSubTenantEditing	Boolean
allowSubTenantViewing	Boolean
tenant	TenantModel
tenantProp	TenantPropModel

Ƭ TenantPropValueModel

名称	类型	描述	示例
id可为空	string
tenantId	string
tenantPropId	string
value可为空	string
tenant	TenantModel
tenantProp	TenantPropModel

Ƭ TenantModel

名称	类型	描述	示例
id可为空	string
name	string
description可为空	string
enabled	Boolean
parentTenantId可为空	string
path可为空	string
order	int32
createTime	ISO DateTime Sting
isSyncedFromExternal	Boolean
providerId可为空	string
parentTenant	TenantModel
tenantPropValues可为空	TenantPropValueModel
userTenants可为空	UserTenantModel
tenantRoles可为空	RoleModel
tenantSettings可为空	TenantSettingModel
tenantPropRestrictions可为空	TenantPropRestrictionModel

Ƭ UserTenantModel

名称	类型	描述	示例
userId	string
tenantId	string
user	UserModel
tenant	TenantModel

Ƭ RoleModel

名称	类型	描述	示例
id可为空	string
name可为空	string
displayName可为空	string
creatorId可为空	string
createTime	ISO DateTime Sting
isBuiltin	Boolean
allowEditPermissions	Boolean
tenantId可为空	string
isSyncedFromExternal	Boolean
providerId可为空	string
modifiedBy可为空	string
modifiedTime	ISO DateTime Sting
creator	UserModel
userRoles可为空	UserRoleModel
permissions可为空	RolePermissionModel
tenant	TenantModel

Ƭ TenantSettingModel

名称	类型	描述	示例
id可为空	string
tenantId可为空	string
pluginKey可为空	string
settingsGroupKey可为空	string
settings可为空	string
tenant	TenantModel
settingsText可为空	string

Ƭ UserModel

名称	类型	描述	示例
id可为空	string
username可为空	string
passwordHash可为空	string
email可为空	string
mobile可为空	string
providerId可为空	string
avatar可为空	string
firstName可为空	string
lastName可为空	string
creationTime	ISO DateTime Sting
enabled	Boolean
fullName可为空	string
organizationIdPath可为空	string
isSyncedFromExternal	Boolean
lastLoginTime可为空	ISO DateTime Sting
passwordChangeTime可为空	ISO DateTime Sting
passwordExpirationPolicy	UserPasswordExpirationPolicy
userRoles可为空	UserRoleModel
userGroups可为空	UserGroupModel
userProperties可为空	UserPropertyModel
extraClaims可为空	UserClaimModel
userTenants可为空	UserTenantModel
userAvatar	UserAvatarModel

Ƭ UserRoleModel

名称	类型	描述	示例
userId可为空	string
roleId可为空	string
user	UserModel
role	RoleModel

Ƭ UserGroupModel

名称	类型	描述	示例
groupId可为空	string
userId可为空	string
group	GroupModel
user	UserModel

Ƭ UserPropertyModel

名称	类型	描述	示例
id可为空	string
userId	string
propertyId	string
propertyValue可为空	string
user	UserModel
property	CustomizePropertyModel

Ƭ UserClaimModel

名称	类型	描述	示例
name可为空	string
value可为空	string
userId可为空	string
user	UserModel

Ƭ UserAvatarModel

名称	类型	描述	示例
userId可为空	string
image可为空	string
lastModified	ISO DateTime Sting
user	UserModel

Ƭ RolePermissionModel

名称	类型	描述	示例
roleId可为空	string
permissionName可为空	string
role	RoleModel

Ƭ GroupModel

名称	类型	描述	示例
id可为空	string
name可为空	string
creatorId可为空	string
creationTime	ISO DateTime Sting
parentGroupId可为空	string
path可为空	string
parentGroup	GroupModel
creator	UserModel
userGroups可为空	UserGroupModel

Ƭ CustomizePropertyModel

名称	类型	描述	示例
id可为空	string
name可为空	string
showInList	Boolean
allowUserEdit	Boolean
multivalued	Boolean
showInProfile	Boolean
valueType	PropertyValueType
sensitive	Boolean
availableValues可为空	CustomizePropertyAvailableValueModel
userProperties可为空	UserPropertyModel

Ƭ CustomizePropertyAvailableValueModel

名称	类型	描述	示例
customizePropertyId可为空	string
value可为空	string
customizeProperty	CustomizePropertyModel

Ƭ TenantPropInfoModel

名称	类型	描述	示例
name	string	组织属性名称。	"OrganizationAddress"
description可为空	string	组织属性的描述文本。	"The address of the organization."
required	Boolean	属性是否为必填项。	true
valueType	PropertyValueType
multivalued	Boolean	属性是否可以有多个值。	true
sensitive	Boolean	属性是否大小写敏感。

Ƭ OrganizationMigrationModel

名称	类型	描述	示例
parentOrgId可为空	string	目标父组织 ID。	"EC6AC4F7-B689-4673-A6B5-C9FE6C979D47"
order	int32	组织的排序。	1