Enterprise API

Enterprise management endpoints

Auto-generated from OpenAPI spec on 2025-10-02

GET /enterprise/roles

GET roles

🔒 Authentication Required: Bearer token

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/enterprise/roles \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/enterprise/roles', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/enterprise/roles',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

POST /enterprise/roles

POST roles

🔒 Authentication Required: Bearer token

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/enterprise/roles \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/enterprise/roles', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.post(
    'https://api.syaala.com/enterprise/roles',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

GET /enterprise/audit

GET audit

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`orgId`	query	Yes	Organization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/enterprise/audit \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/enterprise/audit', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/enterprise/audit',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

GET /enterprise/analytics

GET analytics

🔒 Authentication Required: Bearer token

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/enterprise/analytics \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/enterprise/analytics', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/enterprise/analytics',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

GET /enterprise/assignments

GET assignments

🔒 Authentication Required: Bearer token

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/enterprise/assignments \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/enterprise/assignments', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/enterprise/assignments',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

POST /enterprise/assignments

POST assignments

🔒 Authentication Required: Bearer token

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/enterprise/assignments \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/enterprise/assignments', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.post(
    'https://api.syaala.com/enterprise/assignments',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

DELETE /enterprise/assignments

DELETE assignments

🔒 Authentication Required: Bearer token

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X DELETE https://api.syaala.com/enterprise/assignments \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/enterprise/assignments', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.delete(
    'https://api.syaala.com/enterprise/assignments',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

PUT /enterprise/roles/{id}

PUT id

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`id`	path	Yes	id identifier

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X PUT https://api.syaala.com/enterprise/roles/abc123 \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/enterprise/roles/abc123', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.put(
    'https://api.syaala.com/enterprise/roles/abc123',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

DELETE /enterprise/roles/{id}

DELETE id

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`id`	path	Yes	id identifier

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X DELETE https://api.syaala.com/enterprise/roles/abc123 \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/enterprise/roles/abc123', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.delete(
    'https://api.syaala.com/enterprise/roles/abc123',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

GET /enterprise/sso/configure

GET configure

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`orgId`	query	Yes	Organization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/enterprise/sso/configure \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/enterprise/sso/configure', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/enterprise/sso/configure',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

POST /enterprise/sso/configure

POST configure

🔒 Authentication Required: Bearer token

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/enterprise/sso/configure \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/enterprise/sso/configure', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.post(
    'https://api.syaala.com/enterprise/sso/configure',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

GET /enterprise/sso/verify

GET verify

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`orgId`	query	Yes	Organization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/enterprise/sso/verify \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/enterprise/sso/verify', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/enterprise/sso/verify',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

POST /enterprise/sso/verify

POST verify

🔒 Authentication Required: Bearer token

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/enterprise/sso/verify \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/enterprise/sso/verify', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.post(
    'https://api.syaala.com/enterprise/sso/verify',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

GET /enterprise/audit/export

GET export

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`orgId`	query	Yes	Organization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/enterprise/audit/export \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/enterprise/audit/export', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/enterprise/audit/export',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

GET /enterprise/sso/providers

GET providers

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`orgId`	query	Yes	Organization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/enterprise/sso/providers \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/enterprise/sso/providers', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/enterprise/sso/providers',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

Auth API API Reference