identity

Users, groups, roles, permissions (opt-in).

• Toolset name: identity

• Enabled by default: no (opt-in with --toolsets default,identity)

• Tools: 23 (10 read-only)

Tools

openvas_create_group

Create group · mutating

Create a user group. Not idempotent.

Parameter	Type	Required	Description
comment	string	no	Optional comment
name	string	yes	Name
users	array	no	Member login names

openvas_create_permission

Create permission · mutating

Grant a permission (a GMP command, optionally scoped to one resource) to a user, group or role. Not idempotent.

Parameter	Type	Required	Description
comment	string	no	Optional comment
name	string	yes	Permission name (a GMP command name, e.g. “get_targets”)
resource_id	string	no	UUID of the grant target resource
resource_type	string	no	Backend resource type of the grant target (e.g. “task”)
subject_id	string	no	UUID of the subject
subject_type	string	no	Who receives the grant: user, group or role

openvas_create_role

Create role · mutating

Create a role. Not idempotent.

Parameter	Type	Required	Description
comment	string	no	Optional comment
name	string	yes	Name
users	array	no	Member login names

openvas_create_user

Create user · mutating

Create a gvmd user account. Not idempotent.

Parameter	Type	Required	Description
authentication_type	string	no	Authentication backend: file, ldap_connect or radius_connect
comment	string	no	Optional comment
hosts	string	no	Host restriction expression as stored by gvmd
name	string	yes	Login name
password	string	no	Initial password (required for file authentication)
roles	array	no	Role UUIDs to assign

openvas_delete_group

Delete group · destructive

Delete a user group (to the trashcan by default; ultimate deletes permanently).

Parameter	Type	Required	Description
id	string	yes	Resource UUID
ultimate	boolean	no	Permanently delete instead of moving to the trashcan (default false)

openvas_delete_permission

Delete permission · destructive

Revoke a permission (to the trashcan by default; ultimate deletes permanently).

Parameter	Type	Required	Description
id	string	yes	Resource UUID
ultimate	boolean	no	Permanently delete instead of moving to the trashcan (default false)

openvas_delete_role

Delete role · destructive

Delete a role (to the trashcan by default; ultimate deletes permanently).

Parameter	Type	Required	Description
id	string	yes	Resource UUID
ultimate	boolean	no	Permanently delete instead of moving to the trashcan (default false)

openvas_delete_user

Delete user · destructive

Delete a user account (to the trashcan by default; ultimate deletes permanently).

Parameter	Type	Required	Description
id	string	yes	Resource UUID
ultimate	boolean	no	Permanently delete instead of moving to the trashcan (default false)

openvas_get_group

Get group · read-only

Get one user group by UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_permission

Get permission · read-only

Get one permission by UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_role

Get role · read-only

Get one role by UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_user

Get user · read-only

Get one user account by UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_user_setting

Get user setting · read-only

Get one user setting by UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_list_groups

List groups · read-only

List user groups.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_list_permissions

List permissions · read-only

List permissions (GMP command grants).

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_list_roles

List roles · read-only

List roles.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_list_user_settings

List user settings · read-only

List the authenticated user’s settings (filterable, not paginated).

Parameter	Type	Required	Description
filter	string	no	GMP filter expression
filter_id	string	no	UUID of a saved filter to apply

openvas_list_users

List users · read-only

List gvmd user accounts with their roles and groups.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_update_group

Update group · destructive

Update a user group’s members or comment. Idempotent (PUT).

Parameter	Type	Required	Description
comment	string	no
id	string	yes	UUID of the group/role to update
users	array	no	Replacement member login names

openvas_update_permission

Update permission · destructive

Update a permission grant. Idempotent (PUT).

Parameter	Type	Required	Description
comment	string	no
id	string	yes	UUID of the permission to update
name	string	no
resource_id	string	no
resource_type	string	no
subject_id	string	no
subject_type	string	no

openvas_update_role

Update role · destructive

Update a role’s members or comment. Idempotent (PUT).

Parameter	Type	Required	Description
comment	string	no
id	string	yes	UUID of the group/role to update
users	array	no	Replacement member login names

openvas_update_user

Update user · destructive

Update a user account (password, roles, host restriction). Idempotent (PUT): omitted fields stay unchanged.

Parameter	Type	Required	Description
authentication_type	string	no
comment	string	no
hosts	string	no
id	string	yes	UUID of the user to update
name	string	no	New login name
password	string	no	New password
roles	array	no	Replacement role UUIDs (omitting leaves roles unchanged)

openvas_update_user_setting

Update user setting · destructive

Change one user setting’s value. Idempotent (PUT).

Parameter	Type	Required	Description
id	string	yes	UUID of the setting
value	string	yes	New value