dotCMS

dotCMS SAML Authentication API

SAML SSO authentication and integration

Documentation GitHub OpenAPI

Business capability

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/dotsaml/login/{idpConfigId} Start a SAML single sign-on login · Initiate SAML login #

Ask an LLM

“How do I send a user to the identity provider's login screen for SAML SSO?”

“What kicks off the SAML authentication request for a site?”

Tell an agent

Start a SAML login for IDP configuration {idpConfigId}.

Redirect me to the identity provider sign-in for {idpConfigId}.

POST /api/v1/dotsaml/login/{idpConfigId} Handle the SAML login callback · Process SAML login callback #

Ask an LLM

“Where does the identity provider post the SAML assertion after a user signs in?”

“Does the SAML callback create the user in dotCMS if they don't exist?”

Tell an agent

Process the SAML assertion callback for IDP configuration {idpConfigId}.

Complete the SSO login and sign the user in for {idpConfigId}.

GET /api/v1/dotsaml/logout/{idpConfigId} Log out of SAML via GET · Process SAML logout (GET) #

Ask an LLM

“How do I start a SAML logout from a browser link?”

“Which GET route ends the SAML session and redirects to the logout page?”

Tell an agent

Start a SAML logout via GET for IDP configuration {idpConfigId}.

Sign me out of SSO for {idpConfigId} using the GET logout link.

POST /api/v1/dotsaml/logout/{idpConfigId} Handle a SAML logout callback via POST · Process SAML logout (POST) #

Ask an LLM

“Where does the identity provider POST its logout callback?”

“Can the IDP send a SAML logout response back with a POST?”

Tell an agent

Process the SAML logout POST callback for IDP configuration {idpConfigId}.

Handle the identity provider's logout POST for {idpConfigId} and redirect to the logout endpoint.

GET /api/v1/dotsaml/metadata/{idpConfigId} Get the SAML service provider metadata · Get SAML metadata #

Ask an LLM

“Where do I get the SP metadata XML to register dotCMS with my identity provider?”

“Is the SAML metadata endpoint limited to administrators?”

Tell an agent

Get the SAML service provider metadata for {idpConfigId}.

Download the SP metadata XML for IDP configuration {idpConfigId}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/dotcms:dotcms-saml-authentication-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: dotCMS REST SAML Authentication API
  version: '3'
  description: SAML SSO authentication and integration
servers:
- url: /
  description: dotCMS Server
tags:
- name: SAML Authentication
  description: SAML SSO authentication and integration
paths:
  /api/v1/dotsaml/login/{idpConfigId}:
    get:
      tags:
      - SAML Authentication
      summary: Initiate SAML login
      description: Initiates a SAML authentication request by redirecting the user to the Identity Provider (IDP) login screen. Requires IDP metadata to determine the SSO login endpoint.
      operationId: doLogin
      parameters:
      - name: idpConfigId
        in: path
        description: Identity Provider configuration ID (typically host ID)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: SAML authentication request initiated successfully (no body)
        '400':
          description: Bad request - invalid IDP configuration ID
          content:
            application/json: {}
        '404':
          description: IDP configuration not found or not enabled
          content:
            application/json: {}
        '500':
          description: Internal server error during SAML authentication initiation
          content:
            application/json: {}
    post:
      tags:
      - SAML Authentication
      summary: Process SAML login callback
      description: Handles the callback from the Identity Provider after successful authentication. Extracts user information from the SAML assertion and creates/logs in the user to dotCMS.
      operationId: processLogin
      parameters:
      - name: idpConfigId
        in: path
        description: Identity Provider configuration ID (typically host ID)
        required: true
        schema:
          type: string
      requestBody:
        description: SAML assertion data from Identity Provider
        content:
          application/xml: {}
          application/x-www-form-urlencoded: {}
        required: true
      responses:
        '200':
          description: SAML login processed successfully - user logged in
          content:
            text/html: {}
        '400':
          description: Bad request - invalid SAML assertion or missing data
          content:
            text/html: {}
        '401':
          description: Unauthorized - SAML assertion validation failed
          content:
            text/html: {}
        '404':
          description: IDP configuration not found or not enabled
          content:
            text/html: {}
        '500':
          description: Internal server error during SAML login processing
          content:
            text/html: {}
  /api/v1/dotsaml/logout/{idpConfigId}:
    get:
      tags:
      - SAML Authentication
      summary: Process SAML logout (GET)
      description: Processes a SAML logout request via GET method. Initiates logout flow and redirects to the configured logout endpoint or builds a logout URL based on the request.
      operationId: logoutGet
      parameters:
      - name: idpConfigId
        in: path
        description: Identity Provider configuration ID (typically host ID)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: SAML logout processed successfully
          content:
            text/html: {}
        '404':
          description: IDP configuration not found or not enabled
          content:
            text/html: {}
        '500':
          description: Internal server error during logout processing
          content:
            text/html: {}
    post:
      tags:
      - SAML Authentication
      summary: Process SAML logout (POST)
      description: Processes a SAML logout request via POST method. Handles logout callbacks from the Identity Provider and redirects to the configured logout endpoint.
      operationId: logoutPost
      parameters:
      - name: idpConfigId
        in: path
        description: Identity Provider configuration ID (typically host ID)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: SAML logout processed successfully
          content:
            text/html: {}
        '404':
          description: IDP configuration not found or not enabled
          content:
            text/html: {}
        '500':
          description: Internal server error during logout processing
          content:
            text/html: {}
  /api/v1/dotsaml/metadata/{idpConfigId}:
    get:
      tags:
      - SAML Authentication
      summary: Get SAML metadata
      description: Renders the XML metadata for the SAML Service Provider configuration. This endpoint is only accessible by administrators and provides the metadata required for IDP configuration.
      operationId: metadata
      parameters:
      - name: idpConfigId
        in: path
        description: Identity Provider configuration ID (typically host ID)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: SAML metadata rendered successfully
          content:
            application/xml: {}
        '401':
          description: Unauthorized - admin access required
          content:
            application/xml: {}
        '403':
          description: Forbidden - user is not an administrator
          content:
            application/xml: {}
        '404':
          description: IDP configuration not found or not enabled
          content:
            application/xml: {}
        '500':
          description: Internal server error rendering metadata
          content:
            application/xml: {}

dotCMS SAML Authentication API

Operations 5

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification