1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-11 13:42:49 +01:00
invoiceninja/openapi/components/schemas/company_user.yaml

46 lines
1.6 KiB
YAML
Raw Normal View History

2023-03-19 00:39:21 +01:00
CompanyUser:
properties:
permissions:
2024-03-09 07:57:16 +01:00
description: 'The user permissionsfor this company in a comma separated list'
2023-03-19 00:39:21 +01:00
type: string
2024-03-09 07:57:16 +01:00
example: 'create_invoice,create_client,view_client'
2023-03-19 00:39:21 +01:00
settings:
2024-03-09 07:57:16 +01:00
description: 'Settings that are used for the flutter applications to store user preferences / metadata'
2023-03-19 00:39:21 +01:00
type: object
2024-03-09 07:57:16 +01:00
readOnly: true
2023-03-19 00:39:21 +01:00
react_settings:
description: 'Dedicated settings object for the react web application'
2024-02-10 05:56:31 +01:00
type: object
2024-03-09 07:57:16 +01:00
readOnly: true
2023-03-19 00:39:21 +01:00
is_owner:
description: 'Determines whether the user owns this company'
type: boolean
example: true
2024-03-09 07:57:16 +01:00
readOnly: true
2023-03-19 00:39:21 +01:00
is_admin:
description: 'Determines whether the user is the admin of this company'
type: boolean
example: true
2024-03-09 07:57:16 +01:00
readOnly: true
2023-03-19 00:39:21 +01:00
is_locked:
description: 'Determines whether the users access to this company has been locked'
type: boolean
example: true
2024-03-09 07:57:16 +01:00
readOnly: true
2023-03-19 00:39:21 +01:00
updated_at:
description: 'The last time the record was modified, format Unix Timestamp'
type: integer
example: '1231232312321'
deleted_at:
description: 'Timestamp when the user was archived, format Unix Timestamp'
type: integer
example: '12312312321'
account:
$ref: '#/components/schemas/Account'
company:
$ref: '#/components/schemas/Company'
user:
$ref: '#/components/schemas/User'
token:
$ref: '#/components/schemas/CompanyToken'
type: object