REST Tenant

The tenant API allows you to get information about configured tenants on your Splunk SOAR (On-premises) deployment. Multi-tenancy is only supported for on-premises deployments of Splunk SOAR.

/rest/tenant

Get information about the tenants configured on the Splunk SOAR (On-premises) deployment.

For information on configuring multi-tenancy, see Configure multiple tenants on your Splunk SOAR (On-premises) instance.

Syntax

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

GET

Expand

Get a list of all configured tenants.

Example request
Get a list of tenants, using paging parameters.

curl -k -u username_password https://localhost/rest/note?page_size=5&page=0 -G -X GET

Example response
A successful GET will return a 200 response, and a JSON formatted list of tenants. This example has multi-tenancy turned on, but only the default tenant is configured.

{
    "count": 1,
    "num_pages": 1,
    "data": [
        {
            "id": 0,
            "name": "Default",
            "description": "This is the default system tenant.",
            "contact": "contact name",
            "disabled": false,
            "slas": {
                "high": 60,
                "medium": 720,
                "low": 1440
            },
            "executive_approvers": null,
            "sla_expiry_warning_in_mins": null,
            "environment_variables": {}
        }
    ]
}