Canonical

Canonical Authentication Service API

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

GitHub OpenAPI

Operations 4

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/v0/auth Start a login to the identity platform admin · Authentication service login #
Ask an LLM
“How do I sign in to the identity platform admin UI?”
“Can I send users back to a specific page after they log in?”
Tell an agent
Start the login flow.
Log me in and redirect to {next} afterwards.
GET /api/v0/auth/callback Complete the login callback · Authentication service callback #
Ask an LLM
“What handles the authorization code returned after sign-in?”
“Which values does the login callback expect from the identity provider?”
Tell an agent
Complete login with authorization code {code} and state {state}.
Finish the sign-in callback for code {code} with scope {scope}.
GET /api/v0/auth/logout Log out of the identity platform admin · Authentication service logout #
Ask an LLM
“How do I sign out of the admin session?”
“Can logout send me to a chosen page afterwards?”
Tell an agent
Log me out.
End my session and redirect to {next}.
GET /api/v0/auth/me Get the signed-in user's profile · Authentication service me #
Ask an LLM
“Who am I signed in as?”
“What profile details does the admin session hold for me?”
Tell an agent
Show my current user profile.
Tell me which account this session is logged in with.

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-service-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-service-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-service-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    name: Identity Platform API
    url: https://github.com/canonical/identity-platform-api
  description: REST API for the Admin UI service
  license:
    name: AGPL-3.0
    url: https://github.com/canonical/identity-platform-api/blob/main/LICENSE
  title: Identity Platform Authentication Service API
  version: '0.1'
tags:
- name: Authentication Service
paths:
  /api/v0/auth:
    get:
      operationId: AuthenticationService_Login
      parameters:
      - in: query
        name: next
        schema:
          type: string
      responses:
        '302':
          content:
            application/json:
              schema: {}
          description: 'Redirects the client to the identity provider''s authorization endpoint.


            The response is a 302 Redirect with a Location header.'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Internal server error
      tags:
      - Authentication Service
      summary: Authentication service login
      x-summary-source: derived
  /api/v0/auth/callback:
    get:
      operationId: AuthenticationService_Callback
      parameters:
      - in: query
        name: code
        schema:
          type: string
      - in: query
        name: scope
        schema:
          type: string
      - in: query
        name: state
        schema:
          type: string
      responses:
        '302':
          content:
            application/json:
              schema: {}
          description: 'This endpoint redirects the client to the original location after authentication.


            The response is a 302 Redirect with a Location header.'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Bad request
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Internal server error
      tags:
      - Authentication Service
      summary: Authentication service callback
      x-summary-source: derived
  /api/v0/auth/logout:
    get:
      operationId: AuthenticationService_Logout
      parameters:
      - in: query
        name: next
        schema:
          type: string
      responses:
        '302':
          content:
            application/json:
              schema: {}
          description: 'This endpoint logs out the client and redirects to the requested location.


            The response is a 302 Redirect with a Location header.'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Forbidden
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Internal server error
      tags:
      - Authentication Service
      summary: Authentication service logout
      x-summary-source: derived
  /api/v0/auth/me:
    get:
      operationId: AuthenticationService_Me
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/authenticationMeResp'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Forbidden
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Internal server error
      tags:
      - Authentication Service
      summary: Authentication service me
      x-summary-source: derived
components:
  schemas:
    authenticationMeResp:
      properties:
        email:
          type: string
        name:
          type: string
        nonce:
          type: string
        sid:
          type: string
        sub:
          type: string
      type: object
    typesErrorResponse:
      properties:
        message:
          type: string
        status:
          format: int32
          type: integer
      type: object
  securitySchemes:
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://example.com/oauth/authorize
          scopes:
            email: ''
            openid: ''
            profile: ''
          tokenUrl: https://example.com/oauth/token
      type: oauth2
externalDocs:
  description: REST API for the Admin UI service
  url: https://github.com/canonical/identity-platform-admin-ui/blob/main/API.md