DocumentationAPI ReferenceRelease Notes
API Reference

Update properties on a Group Policy resource.

patch
https://sespog-rs.qabeyondtrustcloud.com/api/config/v1/group-policy/

Modifies an existing group policy with the given {id} using the given properties.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
1 to 2147483647

Unique identifier for the group policy.

Body Params

The Group Policy properties to modify.

string
required
length between 1 and 255

The name of the group policy.

string
enum
Defaults to not_allowed

Allowed to provide remote support.

Allowed:
string
enum

This field indicates if this policy defines representative permissions or not. A value of 'defined' means the policy defines values for representative 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 representative permission fields; otherwise the default is "not_defined".

Allowed:
boolean
Defaults to false

Allowed to generate session keys for support sessions within the Representative Console.

boolean
Defaults to false

Allowed to generate access keys for sending iOS profiles.

boolean
Defaults to false

Allowed to manually accept sessions from a team queue.

boolean
Defaults to false

Allowed to transfer sessions to teams which they do not belong to.

boolean
Defaults to false

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

boolean
Defaults to false

Allowed to invite external support Representatives.

int32
-1 to 86400
Defaults to -1

Remove Representative 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".

boolean
Defaults to false

Allowed to use the Get Next Session feature.

boolean
Defaults to false

Allowed to enable extended availability mode.

boolean
Defaults to false

Allowed to edit the external key.

boolean
Defaults to false

Allowed to opt-out of session assignments.

int32
0 to 3600
Defaults to 900

Do not assign sessions if the representative has been idle in seconds. Allowed values are 0, 180, 300, 600, 900, 1200, 1800, 2700, and 3600. 0 Means "No timeout".

int32
1 to 10
Defaults to 3

Do not assign sessions if the representative is participating in more sessions.

boolean
Defaults to false

Allowed to show screen to other Representatives.

boolean
Defaults to false

Allowed to give control when showing screen to other Representatives.

boolean
Defaults to false

Allowed to use Jump Clients.

boolean
Defaults to false

Allowed to use Local Jump (Windows only).

boolean
Defaults to false

Allowed to use Remote Jump.

boolean
Defaults to false

Allowed to use Remote VNC.

boolean
Defaults to false

Allowed to use Remote RDP.

boolean
Defaults to false

Allowed to use SSH.

boolean
Defaults to false

Allowed to use Local VNC.

boolean
Defaults to false

Allowed to use Local RDP.

boolean
Defaults to false

Allowed to use Intel vPro.

int32
1 to 2147483647
Defaults to 1

Default Asset Role.

int32
1 to 2147483647
Defaults to 1

Personal Asset Role.

int32
1 to 2147483647
Defaults to 1

Teams Asset Role.

int32
1 to 2147483647
Defaults to 1

System Asset Role.

int32
-1 to 86400
Defaults to -1

Representative Console Idle Timeout in 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".

string
enum
Defaults to optional

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

Allowed:
Responses

Updated 6 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.