octoprint-open-api/openapi/components/schemas/access/UserRecord.yaml
2020-10-31 14:36:19 +01:00

46 lines
1.2 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

type: object
description: >-
User record
properties:
name:
type: string
description: >-
The users name
active:
type: boolean
description: >-
Whether the users account is active (true) or not (false)
user:
type: boolean
description: >-
Whether the user has user rights. Should always be true. Deprecated as of 1.4.0, use the users group instead.
admin:
type: boolean
description: >-
Whether the user has admin rights (true) or not (false). Deprecated as of 1.4.0, use the admins group instead.
apiKey:
type: string
description: >-
The users personal API key
settings:
type: object
description: >-
The users personal settings, might be an empty object.
groups:
type: array
description: >-
Groups assigned to the user
items:
$ref: ./GroupRecord.yaml
permissions:
type: array
description: >-
The list of permissions assigned to the user (note: this does not include implicit permissions inherit from groups).
items:
$ref: ./PermissionRecord.yaml
needs:
description: >-
Effective needs of the user
$ref: ./Needs.yaml