DocumentationAPI ReferenceRelease Notes
API Reference

Update the Jump Item association criteria.

Update the Jump Item association criteria for the Account or Secret with the given {id} using the data in the request body.

You may change either or both of the filter_type and criteria properties of the association object in a single request, but criteria will be ignored if the filter_type is not set to "criteria". Updating filter_type from "criteria" to "any_jump_items" or "no_jump_items" implicitly deletes all previous criteria for the account or secret.

If you want the account to inherit associations from its Account Group you must use the endpoint:

You may specify some or all of the available criteria properties. Each criteria property you supply will replace the previous value for that property. To keep the existing values for a certain property, omit that property from the request. Separate APIs exist for adding or deleting single Jump Items or shared Jump Groups, which might be preferable to supplying the entire array of ids with this API:

This API cannot be used if the given Account or Secret is inheriting Jump Item association criteria from its Account Group and does not have any of its own Jump Item associations defined. To create association criteria specifically for this Account or Secret, use the POST API instead.

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 resource.

Body Params

Describes Jump Item association criteria for Vault Accounts and Account Groups. The criteria property is only allowed if the filter_type is "criteria".

string
enum
required

The following values are allowed:

  • any_jump_items: The account(s) can be injected within any session started from a Jump Item where the account(s) is/are applicable.
  • no_jump_items: The account(s) cannot be injected into any session started from a Jump Item.
  • criteria: The account(s) can be injected only within sessions started from Jump Items that match the criteria you define, where the account is applicable. This uses the given criteria and jump_items to identify which Jump Items the applicable account(s) should be associated with.
Allowed:
criteria
object

All items in host, name, tag and comment will be converted to lowercase.

jump_items
array of objects

Array of identifiers for Jump Items that should be directly associated with the account(s).

jump_items
Response

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

©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.