light-mode-image
Learn
API ReferenceEnvironments

Retrieve environments

Analytics Events

ENVIRONMENT_RETRIEVE_LIST_STARTENVIRONMENT_RETRIEVE_LIST_SUCCESSENVIRONMENT_RETRIEVE_LIST_FAIL
GET/v1/environments

Retrieves a list of all available environments.

Analytic events

  • ENVIRONMENT_RETRIEVE_LIST_START
  • ENVIRONMENT_RETRIEVE_LIST_SUCCESS
  • ENVIRONMENT_RETRIEVE_LIST_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000
Default100
cursor?string

Starting point for the list of entries.

Response Body

application/json

application/json

text/plain

curl -X GET "https://example.com/v1/environments"
{  "data": [    {      "id": "string",      "name": "string",      "domain": "string",      "authorizationServerDomain": "string",      "deploymentModel": "public",      "region": {        "id": "string",        "name": "string",        "displayName": "string"      }    }  ],  "nextCursor": "string"}

How would you rate this page?

Retrieve security settings GET

Retrieves the current security settings for MATTR portal authentication. <Callout> This endpoint is part of SaaS Security Posture Management (SSPM) support, an add-on feature that is currently available only for dedicated cloud deployments. It is only available when SSPM support is enabled in your environment. Contact us if you would like to enable it. </Callout> ### **Analytic events** * SECURITY_SETTINGS_RETRIEVE_START * SECURITY_SETTINGS_RETRIEVE_SUCCESS * SECURITY_SETTINGS_RETRIEVE_FAIL

Create tenant POST

Creates a new tenant in the requested environment. ### **Analytic events** * TENANT_CREATE_START * TENANT_CREATE_SUCCESS * TENANT_CREATE_FAIL