Table Of Contents
- JSON-RPC 2.0 over WebSocket API
- API Methods
- acme.dns.authenticator
- alert
- alertclasses
- alertservice
- api_key
- app
- app.available
- app.available_space
- app.categories
- app.certificate_authority_choices
- app.certificate_choices
- app.config
- app.container_console_choices
- app.container_ids
- app.convert_to_custom
- app.create
- app.delete
- app.get_instance
- app.gpu_choices
- app.ip_choices
- app.latest
- app.outdated_docker_images
- app.pull_images
- app.query
- app.redeploy
- app.rollback
- app.rollback_versions
- app.similar
- app.start
- app.stop
- app.update
- app.upgrade
- app.upgrade_summary
- app.used_ports
- app.image
- app.ix_volume
- app.registry
- auth
- boot.environment
- catalog
- certificate
- cloud_backup
- cloudsync
- cloudsync.credentials
- config
- core
- cronjob
- device
- disk
- docker
- docker.network
- enclosure.label
- failover.reboot
- filesystem
- filesystem.acltemplate
- ftp
- group
- initshutdownscript
- ipmi
- iscsi.auth
- iscsi.extent
- iscsi.global
- iscsi.initiator
- iscsi.portal
- iscsi.target
- iscsi.targetextent
- k8s_to_docker
- keychaincredential
- keychaincredential.create
- keychaincredential.delete
- keychaincredential.generate_ssh_key_pair
- keychaincredential.get_instance
- keychaincredential.query
- keychaincredential.remote_ssh_host_key_scan
- keychaincredential.remote_ssh_semiautomatic_setup
- keychaincredential.setup_ssh_connection
- keychaincredential.update
- keychaincredential.used_by
- nfs
- pool
- pool.dataset
- pool.resilver
- pool.scrub
- pool.snapshottask
- pool.snapshottask.create
- pool.snapshottask.delete
- pool.snapshottask.delete_will_change_retention_for
- pool.snapshottask.get_instance
- pool.snapshottask.max_count
- pool.snapshottask.max_total_count
- pool.snapshottask.query
- pool.snapshottask.run
- pool.snapshottask.update
- pool.snapshottask.update_will_change_retention_for
- privilege
- reporting
- reporting.exporters
- sharing.nfs
- sharing.smb
- smb
- snmp
- staticroute
- system
- system.general
- system.ntpserver
- system.reboot
- system.security
- system.security.info
- tn_connect
- truenas
- user
- virt.device
- virt.global
- virt.instance
- virt.instance.create
- virt.instance.delete
- virt.instance.device_add
- virt.instance.device_delete
- virt.instance.device_list
- virt.instance.device_update
- virt.instance.get_instance
- virt.instance.image_choices
- virt.instance.query
- virt.instance.restart
- virt.instance.start
- virt.instance.stop
- virt.instance.update
- virt.volume
- API Events
- acme.dns.authenticator
- alert
- alertservice
- api_key
- app
- app.image
- app.registry
- cloud_backup
- cloudsync.credentials
- cronjob
- docker.network
- filesystem.acltemplate
- group
- initshutdownscript
- iscsi.auth
- iscsi.extent
- iscsi.initiator
- iscsi.portal
- iscsi.target
- iscsi.targetextent
- keychaincredential
- pool.scrub
- pool.snapshottask
- privilege
- reporting.exporters
- sharing.nfs
- staticroute
- system.ntpserver
- user
- virt.instance
- virt.volume
- Jobs
- Query Methods
Previous topic
Next topic
privilege.create¶
Creates a privilege.
name is a name for privilege (must be unique).
local_groups is a list of local user account group GIDs that gain this privilege.
ds_groups is list of Directory Service group GIDs that will gain this privilege.
roles is a list of roles to be assigned to the privilege
web_shell controls whether users with this privilege are allowed to log in to the Web UI.
Type: object
No Additional Properties
No Additional Items
Type: array
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
No Additional Items
Tuple Validation
Parameter 1: privilege_create
privilege_create
Type: objectNo Additional Properties
Name
Type: stringMust be at least 1
characters long
Local Groups
Type: array of integer Default: []No Additional Items
Each item of this array must be:
Type: integer
Roles
Type: array of string Default: []No Additional Items
Each item of this array must be:
Type: string
Web Shell
Type: booleanPrivilegeEntry
Type: objectNo Additional Properties
Id
Type: integerName
Type: stringMust be at least 1
characters long
Roles
Type: array of string Default: []No Additional Items
Each item of this array must be:
Type: string
Web Shell
Type: booleanRequired roles: PRIVILEGE_WRITE