Canonical Oidc API

The Oidc_Api API from Canonical — 2 operation(s) for oidc_api.

Operations 2

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

POST /oidc/auth-init Start an OIDC sign-in · Initiate client request and proxy request to OIDC provider #
Ask an LLM
“How does a client begin authenticating through the OIDC provider?”
“Which parameters do I get back to start an OIDC login?”
Tell an agent
Start an OIDC authentication request.
Initiate OIDC sign-in and give me the parameters to authenticate.
POST /oidc/auth-poll/{request_id} Poll for an OIDC sign-in result · Poll for OIDC authentication result based on request ID #
Ask an LLM
“Has my OIDC login finished yet?”
“Can I get the user info once OIDC authentication succeeds?”
Tell an agent
Poll for the OIDC result of request {request_id}.
Check whether OIDC request {request_id} has authenticated.

Documentation

Specifications

Other Resources

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-oidc-api-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.

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

OpenAPI Specification

canonical-oidc-api-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Testflinger Oidc API
  version: 1.0.0
servers:
- url: https://testflinger.ps7.canonical.com/
tags:
- name: Oidc_Api
paths:
  /oidc/auth-init:
    post:
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful response
      tags:
      - Oidc_Api
      summary: Initiate client request and proxy request to OIDC provider
      description: ':return: dict containing required OIDC parameters for client to

        authenticate with provider'
      operationId: postOidcAuthInit
      x-operation-id-source: derived
  /oidc/auth-poll/{request_id}:
    post:
      parameters:
      - in: path
        name: request_id
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful response
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Not found
      tags:
      - Oidc_Api
      summary: Poll for OIDC authentication result based on request ID
      description: ':param request_id: unique request ID generated during auth initiation

        :return: dict containing authentication result and user info if successful'
      operationId: postOidcAuthPollByRequestId
      x-operation-id-source: derived
components:
  schemas:
    HTTPError:
      properties:
        detail:
          type: object
        message:
          type: string
      type: object