Azure Active Directory (Entra ID) API
Use these operations to interact with the Azure Active Directory (Entra ID) integration in Cortex.
Operations
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.
Successfully found configuration
Bad Request
Configuration not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
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"
}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.
Successfully added configuration
Bad Request
Forbidden
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
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"
}
]
}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.
Successfully replaces configuration
Bad Request
Forbidden
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
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"
}
]
}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.
Successfully validated configuration
Configuration not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
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"
}
]
}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.
Successfully deleted configuration
Bad Request
Forbidden
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
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"
}
]
}Last updated
Was this helpful?