Canonical

Canonical Authentication API

The authentication API from Canonical — 4 operation(s) for authentication.

GitHub OpenAPI

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 /v1/auth/saml/login Start a SAML single sign-on login · Saml Login #
Ask an LLM
“How do I sign in with SAML single sign-on?”
“Can I send the user back to a specific page after SAML login?”
Tell an agent
Start a SAML login and return me to {return_to}.
Begin SAML sign-in through the identity provider.
GET /v1/auth/saml/logout Start a SAML logout · Saml Logout #
Ask an LLM
“How do I log out of a SAML session?”
“Where does the user land after a SAML sign-out?”
Tell an agent
Log me out via SAML and return to {return_to}.
End my SAML single sign-on session.
POST /v1/auth/saml/acs Receive the SAML login assertion · Saml Login Callback #
Ask an LLM
“Which endpoint is the SAML assertion consumer service?”
“Where does the identity provider post the login response?”
Tell an agent
Post the identity provider's SAML login assertion to the ACS.
Complete the SAML login callback.
GET /v1/auth/saml/sls Handle a SAML logout redirect · Saml Logout Callback #
Ask an LLM
“Which URL handles a SAML single logout redirect?”
“How is a redirect-binding SAML logout response processed?”
Tell an agent
Process the SAML single logout redirect.
Handle the logout response the IdP redirected back.
POST /v1/auth/saml/sls Handle a posted SAML logout response · Saml Logout Callback #
Ask an LLM
“Can the identity provider post the SAML logout response instead of redirecting?”
“What endpoint accepts a POST-binding single logout message?”
Tell an agent
Post the SAML single logout message to the SLS.
Complete the POST-binding logout callback.

Documentation

📖
Documentation
https://snapcraft.io/docs/reference/development/snapd-rest-api/
📖
Documentation
https://ubuntu.com/landscape/docs
📖
APIReference
https://documentation.ubuntu.com/landscape/reference/api/
📖
Documentation
https://documentation.ubuntu.com/lxd/latest/rest-api/
📖
APIReference
https://documentation.ubuntu.com/lxd/latest/api-extensions/
📖
Documentation
https://ubuntu.com/security/api/docs
📖
APIReference
https://ubuntu.com/security/api/spec.json
📖
Documentation
https://documentation.ubuntu.com/pebble/
📖
Documentation
https://canonical-testflinger.readthedocs-hosted.com/en/latest/
📖
Documentation
https://documentation.ubuntu.com/anbox-cloud/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-authentication-api-openapi.yml

Other Resources

🔗
HowTo
https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
🔗
ReleaseNotes
https://documentation.ubuntu.com/landscape/reference/release-notes/
🔗
Portal
https://ubuntu.com/landscape
🔗
SourceCode
https://github.com/canonical/lxd
🔗
Portal
https://canonical.com/lxd
🔗
Portal
https://ubuntu.com/security
🔗
SourceCode
https://github.com/canonical/pebble
🔗
SourceCode
https://github.com/canonical/testflinger
🔗
SourceCode
https://github.com/canonical/hardware-api
🔗
Portal
https://ubuntu.com/certified
🔗
SourceCode
https://github.com/canonical/identity-platform-api
🔗
SourceCode
https://github.com/canonical/test_observer
🔗
Portal
https://canonical.com/anbox-cloud
🔗
SourceCode
https://github.com/canonical/cos-registration-server

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/canonical:canonical-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

canonical-authentication-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Test Observer Authentication API
  description: Test Observer API (see https://github.com/canonical/test_observer)
  license:
    name: GNU Affero General Public License v3
    url: https://raw.githubusercontent.com/canonical/test_observer/refs/heads/main/backend/LICENSE
  version: 0.1.0
tags:
- name: Authentication
paths:
  /v1/auth/saml/login:
    get:
      tags:
      - Authentication
      summary: Saml Login
      operationId: saml_login_v1_auth_saml_login_get
      parameters:
      - name: return_to
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Return To
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/saml/logout:
    get:
      tags:
      - Authentication
      summary: Saml Logout
      operationId: saml_logout_v1_auth_saml_logout_get
      parameters:
      - name: return_to
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Return To
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/auth/saml/acs:
    post:
      tags:
      - Authentication
      summary: Saml Login Callback
      operationId: saml_login_callback_v1_auth_saml_acs_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /v1/auth/saml/sls:
    get:
      tags:
      - Authentication
      summary: Saml Logout Callback
      operationId: saml_logout_callback_v1_auth_saml_sls_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    post:
      tags:
      - Authentication
      summary: Saml Logout Callback
      operationId: saml_logout_callback_v1_auth_saml_sls_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError