API commands

This topic describes the Secure Web Sessions set of REST APIs that you can use to automate tasks.

Access SWS APIs

The SWS Public APIs can be accessed here. To view the SWS APIs, make sure the selected definition at the top of the page is Secure Web Sessions API v2-edge.

The following table lists the APIs that are currently available for Secure Web Sessions:

Name

Description

GET SWS policies

Retrieves a list of SWS application policies, according to a query.

 

GET policies (policy ID)

Retrieves details about a SWS policy, identified by its ID.

All the security layer parameters should be selected so that all details about an identified policy are retrieved.

PUT SWS users

Updates the SWS user's status (Activated/Deactivated).

GET SWS users (user ID)

Retrieves details about a SWS user, identified by their ID.

DELETE SWS users (user ID)

Deletes a SWS user, identified by their ID.

The user is only deleted from the SWS tenant, and not from CyberArk Identity.

GET SWS users

Retrieves a list of SWS users, according to a query.

GET SWS activities

Retrieves a list of SWS activities, according to a specified time period.

GET SWS recordings

Retrieves a list of session recordings within a specific time frame.

GET SWS recordings (recording ID)

Retrieves details about specific steps taken in a particular session (identified by ID).

GET SWS sessions

Retrieves a list of sessions within a specific time frame.

GET SWS sessions (session ID)

Retrieves details about a SWS session, identified by their ID.

GET SWS sessions (steps)

Retrieves details about specific steps taken within a particular SWS session, identified by their ID.

The GetSessions API's have been added in addition to the GetRecordings API's in order to align with industry standards. The GetRecordings API's will continue to be supported for backwards compatibility, but new improvements will only be made to the GetSessions API's.

You can import to Postman a collection of SWS API templates to help begin creating your APIs.

Download the SWS APIs collection .jason file, and then import into Postman.