Skip to main content
Splunk® SOAR (On-premises)

REST API Reference for Splunk SOAR (On-premises)

Splunk® SOAR (On-premises)
5.2.1
As of version 6.4.0, the visual editor for classic playbooks is no longer part of Splunk SOAR. Before upgrading, convert your classic playbooks to modern mode. Your classic playbooks will continue to run and you can view and edit them in the SOAR Python code editor.
For details, see:
This documentation does not apply to the most recent version of Splunk® SOAR (On-premises). For documentation on the most recent version, go to the latest release.

REST User

Two types of users may be provisioned in Splunk SOAR (On-premises), "automation" users and "normal" users. Automation users are excluded from general user queries by default. To include automation users you can either use a filter /rest/ph_user?_filter_type__in=["normal", "automation"] or as a convenience, use the GET parameter include_automation, for example: /rest/ph_user?include_automation.

/rest/ph_user

Manage users.

Syntax

https://<username>:<password>@<host>/rest/ph_user

POST

Expand

Create users.

GET

Expand

Retrieve user data.

/rest/ph_user/<userid>

Manage a user.

Syntax

https://<username>:<password>@<host>/rest/ph_user/<userid>

GET

Expand

Retrieve user data for one user.

POST

Expand

Update an existing user.

DELETE

Expand

Delete a user.

/rest/ph_user/<userid>/token

Get token information.

Syntax

https://<username>:<password>@<host>/rest/ph_user/:id/<token>

GET

Expand

Retrieve information about your token. This endpoint is only accessible to automation users, and can only be used to get information for your own token.

Last modified on 05 September, 2024
REST System Settings   REST User Settings

This documentation applies to the following versions of Splunk® SOAR (On-premises): 5.1.0, 5.2.1, 5.3.1, 5.3.2, 5.3.3, 5.3.4, 5.3.5, 5.3.6, 5.4.0, 5.5.0


Please expect delayed responses to documentation feedback while the team migrates content to a new system. We value your input and thank you for your patience as we work to provide you with an improved content experience!

Was this topic useful?







You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters