API Reference

Create Session by Request

post
https://example.com/beyondtrust/api/public/v3/requests//sessions

Creates a Session for an approved Request.

Required Permission(s)

  • Must be the owner of the Request.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The ID of the approved Request for which to create the Session

Body Params

Session configuration

Create Password Safe Session

string | null

(required) Type of session:

  • SSH or sshticket
  • RDP or rdpticket
  • rdpfile
  • app
  • appfile
string | null
Defaults to <configured default resolution>

(RDP-only) RDP Session resolution (i.e 1024x768, 1920x1600, Maximized, etc.)

uuid | null

ID of the Session Node to establish the Session. If NodeID is not given or if the Remote Session Proxy feature is disabled, uses the local node.

boolean | null
Defaults to false

(RDP-only) True to perform a Remote Administration Session (mstsc /admin), otherwise false

boolean
Defaults to false

(RDP-only) True to use all monitors, otherwise false (when <see cref="P:BeyondTrust.PasswordSafe.API.Models.SessionAddModel.SessionType">SessionType</see>=rdpfile)

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated this month

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated this month

Did this page help you?