mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-14 15:13:29 +01:00
92 lines
3.3 KiB
YAML
92 lines
3.3 KiB
YAML
CompanyUser:
|
|
properties:
|
|
permissions:
|
|
description: 'The user permissionsfor this company in a comma separated list'
|
|
type: string
|
|
example: 'create_invoice,create_client,view_client'
|
|
settings:
|
|
description: 'Settings that are used for the flutter applications to store user preferences / metadata'
|
|
type: object
|
|
readOnly: true
|
|
react_settings:
|
|
description: 'Dedicated settings object for the react web application'
|
|
type: object
|
|
readOnly: true
|
|
is_owner:
|
|
description: 'Determines whether the user owns this company'
|
|
type: boolean
|
|
example: true
|
|
readOnly: true
|
|
is_admin:
|
|
description: 'Determines whether the user is the admin of this company'
|
|
type: boolean
|
|
example: true
|
|
readOnly: true
|
|
is_locked:
|
|
description: 'Determines whether the users access to this company has been locked'
|
|
type: boolean
|
|
example: true
|
|
readOnly: true
|
|
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/UserRef'
|
|
token:
|
|
$ref: '#/components/schemas/CompanyToken'
|
|
type: object
|
|
CompanyUserRef:
|
|
properties:
|
|
permissions:
|
|
description: 'The user permissionsfor this company in a comma separated list'
|
|
type: string
|
|
example: 'create_invoice,create_client,view_client'
|
|
settings:
|
|
description: 'Settings that are used for the flutter applications to store user preferences / metadata'
|
|
type: object
|
|
readOnly: true
|
|
react_settings:
|
|
description: 'Dedicated settings object for the react web application'
|
|
type: object
|
|
readOnly: true
|
|
is_owner:
|
|
description: 'Determines whether the user owns this company'
|
|
type: boolean
|
|
example: true
|
|
readOnly: true
|
|
is_admin:
|
|
description: 'Determines whether the user is the admin of this company'
|
|
type: boolean
|
|
example: true
|
|
readOnly: true
|
|
is_locked:
|
|
description: 'Determines whether the users access to this company has been locked'
|
|
type: boolean
|
|
example: true
|
|
readOnly: true
|
|
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/UserRef'
|
|
token:
|
|
$ref: '#/components/schemas/CompanyToken'
|
|
type: object |