Create a Group Policy.

post

https://techcomcloudpra.qabeyondtrustcloud.com/api/config/v1/group-policy

Adds a new group policy resource.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

New group policy properties.

name

string

required

length between 1 and 255

The name of the group policy.

perm_access_allowed

boolean

Defaults to false

Allowed to access endpoints.

access_perm_status

string

enum

Defaults to not_defined

This field indicates if this policy defines user permissions or not. A value of 'defined' means the policy defines values for user permissions. A value of 'final' is the same as defined, except it will also prevent other policies of lower priority from overriding the permission value set by this Policy. The default value is "defined" if the request includes any user permission fields; otherwise the default is "not_defined".

Allowed:

perm_share_other_team

boolean

Defaults to false

Allowed to share sessions with teams which they do not belong to.

perm_invite_external_user

boolean

Defaults to false

Allowed to invite external Users.

perm_session_idle_timeout

int32

-1 to 86400

Defaults to -1

Remove User from the session after they've been inactive for a certain number of seconds. Allowed values are -1, 0, 300, 600, 900, 1800, 3600, 7200, 14400, 28800, 43200, and 86400. -1 means "Use site wide setting". 0 means "No timeout".

perm_extended_availability_mode_allowed

boolean

Defaults to false

Allowed to enable extended availability mode.

perm_edit_external_key

boolean

Defaults to false

Allowed to edit the external key.

perm_collaborate

boolean

Defaults to false

Allowed to show screen to other Users.

perm_collaborate_control

boolean

Defaults to false

Allowed to give control when showing screen to other Users.

perm_jump_client

boolean

Defaults to false

Allowed to use Jump Clients.

perm_local_jump

boolean

Defaults to false

Allowed to use Local Jump (Windows only).

perm_remote_jump

boolean

Defaults to false

Allowed to use Remote Jump.

perm_remote_vnc

boolean

Defaults to false

Allowed to use Remote VNC.

perm_remote_rdp

boolean

Defaults to false

Allowed to use Remote RDP.

perm_shell_jump

boolean

Defaults to false

Allowed to use SSH.

perm_web_jump

boolean

Defaults to false

Allowed to use Web Jump.

perm_protocol_tunnel

boolean

Defaults to false

Allowed to use Protocol Tunnel Jump.

perm_sd_static_port_for_external_tools

boolean

Defaults to false

Allowed to use static port and username for external tool sessions.

default_jump_item_role_id

int32

1 to 2147483647

Defaults to 1

Default Asset Role.

private_jump_item_role_id

int32

1 to 2147483647

Defaults to 1

Personal Asset Role.

inferior_jump_item_role_id

int32

1 to 2147483647

Defaults to 1

Teams Asset Role.

unassigned_jump_item_role_id

int32

1 to 2147483647

Defaults to 1

System Asset Role.

two_factor_type

string

enum

Defaults to optional

The type of two-factor authentication required for users in this group policy.

Allowed:

Responses

201Indicates the group policy was created successfully and contains the new group policy instance. The Location header contains the URL of the new group policy.

422One or more request parameters are invalid. The body contains a general error message as well as a validation error dictionary.