DocumentationAPI ReferenceRelease Notes
API Reference

Add Jump Item association criteria for an Account.

For an account that has no explicit Jump Item associations defined and is currently inheriting association criteria from its Account Group, this API will add Jump Item association criteria for the Account with the given {id} using the data in the request body. This should be used only if the Account does not already have any Jump Item association defined.

If you set the filter_type to "criteria", then you must provide some properties in the criteria field. You may specify some or all of the available criteria properties. Once you have created association criteria with this POST API, separate APIs exist for adding or deleting single Jump Item or shared Jump Group ids from their respective lists in criteria, which might be preferable to supplying the entire array of ids up front with this API:

If the filter_type is set to "any_jump_items" or "no_jump_items", the criteria field will be ignored.

Once you have used this API to add Jump Item association criteria, use the PATCH API to change the filter_type and / or criteria. To change this Account back to inheriting Jump Item association criteria from its Account Group, use the DELETE API.

This API cannot be used if the Account already has Jump Item association criteria defined. If you wish to update the current Jump Item association criteria, use the PATCH 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
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.