Azure Active Directory (Entra ID) API

Use these operations to interact with the Azure Active Directory (Entra ID) integration in Cortex.

Operations

Retrieve a configuration

get

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Responses

200

Successfully found configuration

application/json

400

Bad Request

application/json

404

Configuration not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/active-directory/default-configuration

HTTPcURLJavaScriptPython

GET /api/v1/active-directory/default-configuration HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "clientId": "text",
  "clientSecretLastFour": "text",
  "groupsFilter": "text",
  "tenantId": "text"
}

Add a configuration

post

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Body

application/json

clientIdstringRequired

clientSecretstringRequired

groupsFilterstringOptional

tenantIdstringRequired

Responses

200

Successfully added configuration

application/json

400

Bad Request

application/json

403

Forbidden

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

/api/v1/active-directory/configuration

HTTPcURLJavaScriptPython

POST /api/v1/active-directory/configuration HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "clientId": "text",
  "clientSecret": "text",
  "groupsFilter": "text",
  "tenantId": "text"
}

{
  "configurations": [
    {
      "clientId": "text",
      "clientSecretLastFour": "text",
      "groupsFilter": "text",
      "tenantId": "text"
    }
  ]
}

Replace the existing configuration

put

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Body

application/json

clientIdstringRequired

clientSecretstringRequired

groupsFilterstringOptional

tenantIdstringRequired

Responses

200

Successfully replaces configuration

application/json

400

Bad Request

application/json

403

Forbidden

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/active-directory/configuration

HTTPcURLJavaScriptPython

PUT /api/v1/active-directory/configuration HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "clientId": "text",
  "clientSecret": "text",
  "groupsFilter": "text",
  "tenantId": "text"
}

{
  "configurations": [
    {
      "clientId": "text",
      "clientSecretLastFour": "text",
      "groupsFilter": "text",
      "tenantId": "text"
    }
  ]
}

Validate a configuration

post

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Responses

200

Successfully validated configuration

application/json

404

Configuration not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

/api/v1/active-directory/configuration/validate

HTTPcURLJavaScriptPython

POST /api/v1/active-directory/configuration/validate HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "configurations": [
    {
      "alias": "text",
      "isValid": true,
      "message": "text"
    }
  ]
}

Delete a configuration

delete

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Responses

200

Successfully deleted configuration

application/json

400

Bad Request

application/json

403

Forbidden

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

/api/v1/active-directory/configurations

HTTPcURLJavaScriptPython

DELETE /api/v1/active-directory/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "configurations": [
    {
      "clientId": "text",
      "clientSecretLastFour": "text",
      "groupsFilter": "text",
      "tenantId": "text"
    }
  ]
}