Update properties on a Jump Client resource.

patch

https://sespog-rs.qabeyondtrustcloud.com/api/config/v1/jump-client/{id}

Modifies an existing Jump Client resource with the given {id} using the given properties.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

1 to 2147483647

Unique identifier for the resource.

Body Params

A Jump Client resource with modified properties.

jump_group_id

int32

required

1 to 2147483647

The unique identifier of the shared Asset Group or user that owns this Jump Client.

jump_group_type

string

enum

Defaults to shared

The type of Asset Group that owns this Jump Client.

Allowed:

name

string

length between 1 and 128

The Jump Client's user-friendly name.

tag

string

length between 0 and 64

The Jump Client's tag.

comments

string

length between 0 and 1024

The Jump Client's comments.

jump_policy_id

int32 | null

1 to 2147483647

The unique identifier of the Asset Policy used to manage access to this Asset.

attended_session_policy_id

int32 | null

2 to 2147483647

The session policy used when an end user is present on the Jump Client system.

unattended_session_policy_id

int32 | null

2 to 2147483647

The session policy used when an end user is not present on the Jump Client system.

public_site_address

string

length between 1 and 128

Defaults to sespog-rs.qabeyondtrustcloud.com

One of the site addresses for one of the public sites configured on the Public Portals → Public Sites page.

support_button_profile_code_name

string

length between 0 and 64

^[a-zA-Z0-9_\\-]+$

If this Jump Client deploys a Support Button on its endpoint, this specifies the Support Button profile.

support_button_direct_queue

string

length between 0 and 69

^team:[a-zA-Z0-9_\\-]+$

If this Jump Client deploys a Support Button on the endpoint, this is the "team:"-prefixed code name of the Team its sessions can be routed directly to. It will be empty if the sessions cannot be routed directly to a Team.

customer_client_start_mode

string

enum

Defaults to normal

This setting determines how sessions are started from the deployed Jump Client. If normal, the customer client will start with the window visible. If minimized, it will start with the window minimized. If hidden, it will start with no visible customer window and will not appear in the taskbar. Hidden mode requires additional permission.

Allowed:

is_quiet

boolean

Defaults to false

If true, sessions started from this Jump Client will start with the UI minimized to avoid disrupting logged in users.

max_offline_minutes

int32

0 to 2147483647

The maximum number of minutes the Jump Client can be offline before being uninstalled. If 0, this Jump Client follows the global lost client settings.

Responses

200Indicates the existing Jump Client was successfully updated and returns the Jump Client.

404The specified resource was not found.

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