Auth API

Auth management endpoints

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

GET /auth/sso

GET sso

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/auth/sso \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/auth/sso', {
  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/auth/sso',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

POST /auth/sso

POST sso

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/auth/sso \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/auth/sso', {
  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/auth/sso',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

PUT /auth/sso

PUT sso

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/auth/sso \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/auth/sso', {
  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/auth/sso',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

DELETE /auth/sso

DELETE sso

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/auth/sso \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/auth/sso', {
  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/auth/sso',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

POST /auth/signup

POST signup

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/auth/signup \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/auth/signup', {
  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/auth/signup',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

POST /auth/signin

POST signin

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/auth/signin \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/auth/signin', {
  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/auth/signin',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

GET /auth/sso/callback/{provider}

GET provider

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`provider`	path	Yes	provider identifier
`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/auth/sso/callback/example-id \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/auth/sso/callback/example-id', {
  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/auth/sso/callback/example-id',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

Admin API Enterprise API