Activity Session
View and manage activity sessions.
List activity sessions by status
Returns activity sessions as a plain list, optionally limited to one status and to one target. Use the paged summary routes instead when you need paging or sorting.
Create and start an activity session
Creates an activity session for the target resource or credential and queues it to start. If the access policy requires approval, the session waits for approval before it is scheduled. The session is created for the signed-in user, and application accounts must name the user in managedAccountId.
Get the connection profile settings of a session
Returns the activity configuration, the connection profile settings, that apply to one activity session. Use it to see what the session allows, such as password access or session extension.
Create a group of activity sessions
Creates one or more activity sessions together as a group and queues them to start. All sessions are created for the signed-in user. This is the route the console uses when a user requests a session. Sessions are created one at a time, so if a later request in the array fails, the sessions created before it remain.
Lock or unlock live activity sessions
Locks or unlocks one or more activity sessions. A locked session shows a message to the user until it is unlocked. You can also lock the user, or the user on one resource, so that new sessions are blocked too.
List your past activity sessions
Returns a page of the signed-in user's sessions that have ended, newest first by default. Use it to review your own session history.
List your activity sessions with a given status
Returns a page of the signed-in user's sessions that have the given status, such as pending, active or waiting for approval. It includes sessions the user created and sessions scheduled for the user.
Get the RDP connection file for a session
Returns the text of a Remote Desktop (.rdp) file that connects the session's owner through the Netwrix Privilege Secure proxy. It works for sessions on Windows and Active Directory resources, and for interactive application launches that use a remote desktop host. The file uses the screen size and display settings from the system settings and is signed when a signing certificate is configured.
Search activity sessions with summary statistics
Searches activity sessions and returns a page of matching session summaries together with the most active users and overall session counts and durations. Use it to build audit and reporting views.
Get the SSH connection URL for a session
Returns the SSH URL that the session's owner uses to connect through the Netwrix Privilege Secure proxy. When the session's connection profile uses automatic connect, the URL carries a one-time token in place of the user name.
Get the summary of one activity session
Returns the summary row for one activity session, with its status, times, resource, activity and access policy.
List past activity sessions
Returns a page of activity sessions that have ended. Administrators can see all users or narrow to one user or group, auditors see the sessions they are allowed to audit, and everyone else sees only their own sessions.
List activity sessions with a given status
Returns a page of activity sessions that have the given status, such as pending, active or waiting for approval. Administrators and auditors can see all users or narrow to one user or group, and everyone else sees only their own sessions.
List activity sessions for one resource
Returns a page of activity sessions on one managed resource. Use it to review who accessed a resource and when.
End an activity session
Ends an activity session as soon as possible. A session that is still waiting for approval is cancelled through the approval process, and any other session is marked for cancellation and ended in the background. The call returns once the end is queued, so poll the session to see it finish.
Get an activity session
Returns the full details of one activity session, including its status, times, resource, activity and connection profile settings. For users other than administrators, allowSessionExtension is false once no extensions remain.
Approve a session that is waiting for approval
Records the signed-in user's approval for an activity session that requires approval. When this approval completes the workflow, the session moves to pending and is scheduled to start.
Check whether you can view the password of a session
Returns true when the signed-in user can view the password for an active credential session, and false in every other case. The check does not return the password.
Deny a session that is waiting for approval
Records the signed-in user's denial for an activity session that requires approval, and cancels the approval process for it. The session does not start.
Extend an activity session by a number of minutes
Adds time to an activity session and returns the updated session. The session's connection profile must allow extensions, extensions must remain, and the requested time cannot exceed the length allowed for one extension. If the body is left out or the number is zero or negative, the full allowed extension is added.
Get the log of an activity session
Returns the log lines recorded for one activity session, limited to the time window of the session. Use it to see what the session did and whether any step failed.
Get the password for an active credential session
Returns the password of the credential that belongs to an active session so the owner can copy it. It is returned as plain text, or as a JSON string when the request accepts JSON.