Jump to Content

Documentation API Reference Release Notes

API Reference

Documentation API Reference Release Notes

All

Pages

Start typing to search…

API GUIDE

PRIVILEGED REMOTE ACCESS API GUIDE

CONFIGURATION API

/api-account
- Get all API Accounts.get
/api-account/{id}
- Get an API Account.get
/cli/{platform}
- Get the CLI tool to interact with Configuration APIs.get
/endpoint-automation/endpoint
- Get all Endpoint Automation Endpoints.get
/endpoint-automation/endpoint/{id}
- Get an Endpoint.get
/endpoint-automation/job
- Get all Endpoint Automation Jobs.get
- Create an Endpoint Automation Job.post
/endpoint-automation/job/{id}
- Get an Endpoint Automation Job.get
/endpoint-automation/job/{id}/execution
- Get all executions of an Endpoint Automation Job.get
/endpoint-automation/resource
- Get all Endpoint Automation Resources.get
/endpoint-automation/resource/{id}
- Get an Endpoint Automation Resource.get
/endpoint-automation/script
- Get all Endpoint Automation Scripts.get
- Create an Endpoint Automation Script.post
/endpoint-automation/script/{id}
- Get an Endpoint Automation Script.get
/endpoint-automation/script/{id}/resource
- Gets all Endpoint Automation Resources associated with the Script.get
/group-policy
- Get a list of Group Policies.get
- Create a Group Policy.post
/group-policy/{id}
/group-policy/{id}/copy
- Duplicate an existing Group Policy.post
/group-policy/{id}/jump-group
- Get Jump Groups added to a Group Policy.get
- Adds a Jump Group to a Group Policy.post
/group-policy/{id}/jump-group/{jump_group_id}
- Get a Jump Group added to a Group Policy.get
- Removes a Jump Group from a Group Policy.del
/group-policy/{id}/jumpoint
- Get a list of Jumpoints added to a Group Policy.get
- Adds a Jumpoint to a Group Policy.post
/group-policy/{id}/jumpoint/{jumpoint_id}
- Get a Jumpoint in a specific Group Policy.get
- Removes a Jumpoint from a Group Policy.del
/group-policy/{id}/member
- Get a list of members added to a Group Policy.get
- Adds a member to a Group Policy.post
/group-policy/{id}/member/{member_id}
- Get a member of a Group Policy.get
- Removes a member from a Group Policy.del
/group-policy/{id}/provision
- Provision the members of a Group Policy.post
/group-policy/{id}/team
- Get Teams added to a Group Policy.get
- Adds a Team to a Group Policy.post
/group-policy/{id}/team/{team_id}
- Get a Team added to a Group Policy.get
- Removes a Team from a Group Policy.del
/group-policy/{id}/vault-account
- Get a list of Vault Accounts associated with this Group Policy.get
- Adds a Vault Account to a Group Policy.post
/group-policy/{id}/vault-account-group
- Get a list of Vault Account Groups associated with this Group Policy.get
- Adds a Vault Account Group to a Group Policy.post
/group-policy/{id}/vault-account-group/{account_group_id}
- Get a Vault Account group added to a Group Policy.get
- Removes a Vault Account group from a Group Policy.del
/group-policy/{id}/vault-account/{account_id}
- Get a Vault Account added to a Group Policy.get
- Removes a Vault Account from a Group Policy.del
/jump-approval/approve
- Answer a Jump Authorization Request.post
/jump-approval/request
- Create a Jump Authorization Request.post
/jump-approval/{user_id}
- Get the Jump Authorization Requests a user is an approver for.get
/jump-approval/{user_id}/view/{id}
- Get the Jump Authorization Request that a user is an approver for.get
/jump-client
- Get all Jump Clients matching query parameters.get
/jump-client/{id}
/jump-client/{id}/copy
- Copy a Jump Client.post
/jump-client/installer
- Get all Jump Client installers matching query parameters.get
- Create a Jump Client installerpost
/jump-client/installer/{id}
- Get a Jump Client installer's information.get
- Delete a Jump Client installer resource.del
/jump-client/installer/{installer_id}/{platform}
- Get the mass deployment installer for the given platform.get
/jump-group
- Get all Jump Group resources matching query parameters.get
- Adds a new Jump Group.post
/jump-group/{id}
/jump-group/{id}/user
- Get a list of Users in a Jump Group.get
- Add a User to a Jump Group.post
/jump-group/{id}/user/{user_id}
/jump-item-role
- Get all Jump Item Roles matching query parameters.get
/jump-item-role/{id}
- Get a Jump Item Role.get
/jump-item/mysql-tunnel-jump
- Get all MySQL jump items matching query parameters.get
- Adds a new MySQL Tunnel Jump Item.post
/jump-item/mysql-tunnel-jump/{id}
/jump-item/mysql-tunnel-jump/{id}/copy
- Copy a MySQL Tunnel Jump Item.post
/jump-item/network-tunnel-jump
- Get all network tunnel jump items matching query parameters.get
- Adds a new Network Tunnel Jump Item.post
/jump-item/network-tunnel-jump/{id}
/jump-item/network-tunnel-jump/{id}/copy
- Copy a Network Tunnel Jump Item.post
/jump-item/protocol-tunnel-jump
- Get all protocol tunnel jump items matching query parameters.get
- Adds a new Protocol Tunnel Jump Item.post
/jump-item/protocol-tunnel-jump/{id}
/jump-item/protocol-tunnel-jump/{id}/copy
- Copy a Protocol Tunnel Jump Item.post
/jump-item/psql-tunnel-jump
- Get all PostgreSQL jump items matching query parameters.get
- Adds a new PostgreSQL Tunnel Jump Item.post
/jump-item/psql-tunnel-jump/{id}
/jump-item/psql-tunnel-jump/{id}/copy
- Copy a PostgreSQL Tunnel Jump Item.post
/jump-item/remote-rdp
- Get all Remote RDP Jump Items matching query parameters.get
- Create a Remote RDP Jump Item.post
/jump-item/remote-rdp/{id}
/jump-item/remote-rdp/{id}/copy
- Copy a Remote RDP Jump Item.post
/jump-item/remote-vnc
- Get all Remote VNC Jump Items matching query parameters.get
- Create a Remote VNC Jump Item.post
/jump-item/remote-vnc/{id}
/jump-item/remote-vnc/{id}/copy
- Copy a Remote VNC Jump Item.post
/jump-item/shell-jump
- Get all shell jump items matching query parameters.get
- Adds a new Shell Jump Item.post
/jump-item/shell-jump/{id}
/jump-item/shell-jump/{id}/copy
- Copy a Shell Jump Item.post
/jump-item/web-jump
- Get all web jump items matching query parameters.get
- Adds a new Web Jump Item.post
/jump-item/web-jump/{id}
/jump-item/web-jump/{id}/copy
- Copy a Web Jump Item.post
/jump-policy
- Get a paginated list of Jump Policy resources.get
- Create a Jump Policy.post
/jump-policy/{id}
/jump-policy/{id}/schedule
- Get the schedule of a jump policy.get
/jumpoint
- Get all Jumpoints.get
- Adds a new Jumpoint.post
/jumpoint/{id}
/jumpoint/{id}/installer
- Get the 64-bit installer for a Jumpoint resource.get
/jumpoint/{id}/node
- Returns the nodes for the Jumpoint with the given `{id}`.get
/jumpoint/{id}/user
- Get a list of Users allowed to access a Jumpoint.get
- Grant a User access to a Jumpoint.post
/jumpoint/{id}/user/{user_id}
- Get a User with access to a Jumpoint.get
- Remove a User's access to a Jumpoint.del
/openapi.yaml
- Get this API documentation in OpenAPI v3 YAML format.get
/security-provider
- Get a list of Security Providers.get
/security-provider/{id}
- Get a Security Provider.get
- Update available_groups on a SAML Security Providers resource.patch
/session-policy
- Get a list of Session Policies.get
/team
- Get all Teams.get
- Create a Team.post
/team/{id}
/team/{id}/user
- List Users on a given Team.get
- Add a User to a Team.post
/team/{id}/user/{user_id}
/user
- Get all Users.get
- Create a local User.post
/user/{id}
/user/{id}/group-policies
- List the group policies a user is a member of.get
/user/{id}/group-policy-changes
- Update the group policy associations for a local User.patch
/user/provision
- Provision Users.post
/vault/account
- Get a list of Vault Accounts.get
- Create a generic Vault Account.post
/vault/account-group
- Get a list of Vault Account Groups.get
- Create a Vault Account Group.post
/vault/account-group/{id}
/vault/account-group/{id}/account
- Get a list of Accounts in a Vault Account Group.get
- Adds a Vault Account to a Vault Account Group.post
/vault/account-group/{id}/account/{account_id}
- Get an account of Vault Account Group.get
- Remove a Vault Account from a Vault Account Group.del
/vault/account-group/{id}/jump-item-association
- Get Jump Item association criteria for an Account Group.get
- Update the Jump Item association criteria for an Account Group.patch
/vault/account-group/{id}/jump-item-association/jump-item
- Add a Jump Item to an Account Group's Jump Item association criteria.post
- Remove a Jump Item from an Account Group's Jump Item association criteria.del
/vault/account-group/{id}/jump-item-association/shared-jump-group
- Add a shared Jump Group to an Account Group's Jump Item association criteria.post
- Remove a shared Jump Group from an Account Group's Jump Item association criteria.del
/vault/account-group/{id}/user
- Get a list of Users with access to a Vault Account Group.get
- Adds a User to a Vault Account Group.post
/vault/account-group/{id}/user/{user_id}
/vault/account-policy
- Get a list of Vault Account Policies.get
- Create a Vault Account Policy.post
/vault/account-policy/{id}
/vault/account/{id}
/vault/account/{id}/check-in
- Check in a Vault Account's password, private key or AWS Secret.post
/vault/account/{id}/check-out
- Check out a Vault Account's password, private key or AWS Secret.post
/vault/account/{id}/force-check-in
- Force check in a Vault Account's password or AWS Secret.post
/vault/account/{id}/jump-item-association
/vault/account/{id}/jump-item-association/jump-item
- Add a Jump Item to the association criteria.post
- Remove a Jump Item from the Jump Item association criteria.del
/vault/account/{id}/jump-item-association/shared-jump-group
- Add a shared Jump Group to the Jump Item association criteria.post
- Remove a shared Jump Group from the Jump Item association criteria.del
/vault/account/{id}/rotate
- Schedules a credential rotation.post
/vault/account/{id}/user
- Get a list of Users with access to a Vault Account.get
- Adds a User to a Vault Account.post
/vault/account/{id}/user/{user_id}
/vault/endpoint
- Get a list of Vault Endpoints.get
/vault/endpoint/{id}/remote-rdp-jump-item-association
- Associate a Remote RDP Jump Item to a Vault endpoint.post
/vault/endpoint/{id}/remote-rdp-jump-item-candidates
- List Remote RDP Jump Items to associate to a vault endpoint.get
/vendor
- Get all Vendor groups.get
- Create a Vendor Group.post
/vendor/{id}
/vendor/{id}/reactivate
- Reactivates all vendor users in a vendor group.post
/vendor/{id}/user
- Get a list of Vendor Users in a Vendor Group.get
- Add a Vendor User to a Vendor Group.post
/vendor/{id}/user/{user_id}
/vendor/{id}/user/{user_id}/reactivate
- Reactivates a vendor user in a vendor group.post

Powered by

Get a User.

get

https://{access.example.com}/api/config/v1/user/{id}

Gets the user resource with the given {id}.

Language

URL

Response

Click Try It! to start a request and see the response here!

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