Canonical

Canonical Authentication Service API

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

Documentation GitHub OpenAPI

Operations 4

GET /api/v0/auth Authentication service login #

GET /api/v0/auth/callback Authentication service callback #

GET /api/v0/auth/logout Authentication service logout #

GET /api/v0/auth/me Authentication service me #

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-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

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:
    typesErrorResponse:
      properties:
        message:
          type: string
        status:
          format: int32
          type: integer
      type: object
    authenticationMeResp:
      properties:
        email:
          type: string
        name:
          type: string
        nonce:
          type: string
        sid:
          type: string
        sub:
          type: string
      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