Files
cloudpods/docs/schemas/user.yaml
T

75 lines
1.6 KiB
YAML

UserListResponse:
type: object
properties:
limit:
type: integer
example: 20
offset:
type: integer
example: 0
total:
type: integer
description: 总量
users:
type: array
items:
$ref: "#/User"
UserGetResponse:
type: object
properties:
user:
type: object
$ref: "#/User"
UserPutRequestInput:
type: object
properties:
name:
type: string
description: 用户的名称
description:
type: string
description: 用户的描述
UserCreateInput:
type: object
properties:
name:
type: string
required: true
description: 用户的名称
password:
type: string
description: 本地用户的密码
description:
type: string
description: 用户的描述
User:
type: object
description: 用户
properties:
id:
type: string
description: 用户ID
readOnly: true
name:
type: string
description: 用户名,域内唯一
can_delete:
type: boolean
description: 是否可以删除
idp_id:
type: string
description: 如果该用户为从认证源导入,则idp_id为该认证源的ID
idp:
type: string
description: 如果该用户为从认证源导入,则idp为该认证源的name
idp_driver:
type: string
description: 如果该用户为从认证源导入,则idp_driver为该认证源的driver
idp_entity_id:
type: string
description: 如果该用户为从认证源导入,则idp_entity_id为该域对应资源的原始ID