Skip to content
POST/api/v1/sso

Configure SSO

Sets up SAML / OIDC with the configured IdP. URLs validated against SSRF defense (ADR-0015) before storage.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Request body required

Example

{
  "orgId": "00000000-0000-0000-0000-000000000000",
  "id": "00000000-0000-0000-0000-000000000000",
  "provider": "saml",
  "domain": "string",
  "idp_entity_id": "string",
  "idp_sso_url": "https://example.com",
  "idp_certificate": "string",
  "oidc_issuer": "https://example.com",
  "oidc_client_id": "string",
  "oidc_client_secret": "string",
  "enabled": false,
  "enforce": false,
  "auto_provision": false,
  "default_role": "admin",
  "metadata": {}
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "orgId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "id": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "provider": {
          "type": "string",
          "enum": [
            "saml",
            "oidc"
          ]
        },
        "domain": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "idp_entity_id": {
          "type": "string",
          "maxLength": 500
        },
        "idp_sso_url": {
          "type": "string",
          "maxLength": 2048,
          "format": "uri"
        },
        "idp_certificate": {
          "type": "string",
          "minLength": 100,
          "maxLength": 20000
        },
        "oidc_issuer": {
          "type": "string",
          "maxLength": 2048,
          "format": "uri"
        },
        "oidc_client_id": {
          "type": "string",
          "maxLength": 500
        },
        "oidc_client_secret": {
          "type": "string",
          "maxLength": 2048
        },
        "enabled": {
          "type": "boolean"
        },
        "enforce": {
          "type": "boolean"
        },
        "auto_provision": {
          "type": "boolean"
        },
        "default_role": {
          "type": "string",
          "enum": [
            "admin",
            "editor",
            "viewer",
            "member"
          ]
        },
        "metadata": {
          "type": "object",
          "additionalProperties": {}
        }
      },
      "required": [
        "orgId",
        "provider",
        "domain"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200SSO configured.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/sso \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "00000000-0000-0000-0000-000000000000", "id": "00000000-0000-0000-0000-000000000000", "provider": "saml", "domain": "string", "idp_entity_id": "string", "idp_sso_url": "https://example.com", "idp_certificate": "string", "oidc_issuer": "https://example.com", "oidc_client_id": "string", "oidc_client_secret": "string", "enabled": false, "enforce": false, "auto_provision": false, "default_role": "admin", "metadata": {} }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/sso",
  body: {
    "orgId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "provider": "saml",
    "domain": "string",
    "idp_entity_id": "string",
    "idp_sso_url": "https://example.com",
    "idp_certificate": "string",
    "oidc_issuer": "https://example.com",
    "oidc_client_id": "string",
    "oidc_client_secret": "string",
    "enabled": false,
    "enforce": false,
    "auto_provision": false,
    "default_role": "admin",
    "metadata": {}
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/sso",
    body={
    "orgId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "provider": "saml",
    "domain": "string",
    "idp_entity_id": "string",
    "idp_sso_url": "https://example.com",
    "idp_certificate": "string",
    "oidc_issuer": "https://example.com",
    "oidc_client_id": "string",
    "oidc_client_secret": "string",
    "enabled": False,
    "enforce": False,
    "auto_provision": False,
    "default_role": "admin",
    "metadata": {}
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"orgId":"00000000-0000-0000-0000-000000000000","id":"00000000-0000-0000-0000-000000000000","provider":"saml","domain":"string","idp_entity_id":"string","idp_sso_url":"https://example.com","idp_certificate":"string","oidc_issuer":"https://example.com","oidc_client_id":"string","oidc_client_secret":"string","enabled":false,"enforce":false,"auto_provision":false,"default_role":"admin","metadata":{}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/sso", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429

Other Admin endpoints