Create Admin Session

post

https://{example.com}/beyondtrust/api/public/v3/sessions/admin

Creates an Administrative Session.

Required Permission(s)

Password Safe Admin Session (Full control)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Administrative Session configuration

Password Safe Admin Session

DomainName

string | null

Domain name used to authenticate

HostName

string | null

(required) Target host Name or IP

NodeID

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.

Password

string | null

Password used to authenticate

Port

int32 | null

Defaults to <configured default port>

Target host Port

RDPAdminSwitch

boolean

Defaults to false

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

Reason

string | null

Reason for the Session

Record

boolean

Defaults to true

True to record the Session, otherwise false. Ignored and always recorded if the Global Setting Hide Record Checkbox for Admin Sessions is enabled.

Resolution

string | null

Defaults to <configured default resolution>

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

SessionType

string | null

(required) Type of session:

SSH or sshticket
RDP or rdpticket
rdpfile

SmartSizing

boolean

Defaults to false

(RDP-only) True to use RDP Smart Sizing, otherwise false (when SessionType=rdpfile)

SpanMultipleMonitors

boolean

Defaults to false

(RDP-only) True to use all monitors, otherwise false (when SessionType=rdpfile)

UserName

string | null

Username used to authenticate

Headers

content-type

string

enum

Defaults to application/*+json

Generated from available request content types

Allowed:

Responses

201Request successful

400Validation failure

401Unauthorized

403Access forbidden