Files
cloudpods/docs/schemas/group.yaml
T

72 lines
1.5 KiB
YAML

GroupListResponse:
type: object
properties:
limit:
type: integer
example: 20
offset:
type: integer
example: 0
total:
type: integer
description: 总量
groups:
type: array
items:
$ref: "#/Group"
GroupGetResponse:
type: object
properties:
group:
type: object
$ref: "#/Group"
GroupPutRequestInput:
type: object
properties:
name:
type: string
description: 组的名称
description:
type: string
description: 组的描述
GroupCreateInput:
type: object
properties:
name:
type: string
required: true
description: 组的名称
description:
type: string
description: 组的描述
Group:
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