Canonical

Canonical Clients Service API

The ClientsService API from Canonical — 2 operation(s) for clientsservice.

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 /api/v0/clients List OAuth clients · Clients service list clients #
Ask an LLM
“Which OAuth clients are registered in the Identity Platform?”
“Can I find OAuth clients by name or owner?”
Tell an agent
List all OAuth clients.
Find OAuth clients named {client_name} owned by {owner}.
POST /api/v0/clients Register an OAuth client · Clients service create client #
Ask an LLM
“How do I register a new OAuth client application?”
“Can I set redirect URIs and grant types when creating a client?”
Tell an agent
Register OAuth client {client_name} with redirect URIs {redirect_uris}.
Create client {client_name} allowing grant types {grant_types} and scope {scope}.
DELETE /api/v0/clients/{id} Delete an OAuth client · Clients service remove client #
Ask an LLM
“How do I delete an OAuth client application?”
“Will removing a client stop it from getting new tokens?”
Tell an agent destructive · confirm first
Delete OAuth client {id}.
Remove client {id} from the Identity Platform.
GET /api/v0/clients/{id} Get an OAuth client · Clients service get client #
Ask an LLM
“What redirect URIs and grant types does a particular client have?”
“Can I look up one OAuth client by its ID?”
Tell an agent
Show OAuth client {id}.
Get the configuration of client {id}.
PUT /api/v0/clients/{id} Update an OAuth client · Clients service update client #
Ask an LLM
“How do I change the redirect URIs of an existing OAuth client?”
“Can I adjust token lifespans on a client that's already registered?”
Tell an agent
Set redirect URIs of existing client {id} to {redirect_uris}.
Update client {id} so access tokens from the auth code grant last {lifespan}.

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-clientsservice-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-clients-client-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-clients-list-clients-resp-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-clients-create-client-resp-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-clients-get-client-resp-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-clients-update-client-resp-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-clients-remove-client-resp-schema.json

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-clientsservice-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-clientsservice-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 Clients Service API
  version: '0.1'
tags:
- name: ClientsService
paths:
  /api/v0/clients:
    get:
      operationId: ClientsService_ListClients
      parameters:
      - in: query
        name: client_name
        schema:
          type: string
      - in: query
        name: owner
        schema:
          type: string
      - in: query
        name: size
        schema:
          type: string
      - in: query
        name: page_token
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/clientsListClientsResp'
          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:
      - ClientsService
      summary: Clients service list clients
      x-summary-source: derived
    post:
      operationId: ClientsService_CreateClient
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/clientsClient'
        required: true
        x-originalParamName: client
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/clientsCreateClientResp'
          description: ''
        '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:
      - ClientsService
      summary: Clients service create client
      x-summary-source: derived
  /api/v0/clients/{id}:
    delete:
      operationId: ClientsService_RemoveClient
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/clientsRemoveClientResp'
          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:
      - ClientsService
      summary: Clients service remove client
      x-summary-source: derived
    get:
      operationId: ClientsService_GetClient
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/clientsGetClientResp'
          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:
      - ClientsService
      summary: Clients service get client
      x-summary-source: derived
    put:
      operationId: ClientsService_UpdateClient
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/clientsClient'
        required: true
        x-originalParamName: client
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/clientsUpdateClientResp'
          description: ''
        '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
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/typesErrorResponse'
          description: Internal server error
      tags:
      - ClientsService
      summary: Clients service update client
      x-summary-source: derived
components:
  schemas:
    clientsGetClientResp:
      properties:
        data:
          $ref: '#/components/schemas/clientsClient'
        message:
          type: string
        status:
          format: int32
          type: integer
      type: object
    clientsListClientsResp:
      properties:
        data:
          items:
            $ref: '#/components/schemas/clientsClient'
          type: array
        message:
          type: string
        meta:
          $ref: '#/components/schemas/typesPagination'
        status:
          format: int32
          type: integer
      type: object
    clientsRemoveClientResp:
      properties:
        message:
          type: string
        status:
          format: int32
          type: integer
      type: object
    clientsUpdateClientResp:
      properties:
        data:
          $ref: '#/components/schemas/clientsClient'
        message:
          type: string
        status:
          format: int32
          type: integer
      type: object
    clientsCreateClientResp:
      properties:
        data:
          $ref: '#/components/schemas/clientsClient'
        message:
          type: string
        status:
          format: int32
          type: integer
      type: object
    typesErrorResponse:
      properties:
        message:
          type: string
        status:
          format: int32
          type: integer
      type: object
    typesPagination:
      properties:
        next:
          type: string
        pageToken:
          type: string
        prev:
          type: string
        size:
          format: int32
          type: integer
      type: object
    clientsClient:
      properties:
        access_token_strategy:
          type: string
        allowed_cors_origins:
          items:
            type: string
          type: array
        audience:
          items:
            type: string
          type: array
        authorization_code_grant_access_token_lifespan:
          type: string
        authorization_code_grant_id_token_lifespan:
          type: string
        authorization_code_grant_refresh_token_lifespan:
          type: string
        backchannel_logout_session_required:
          type: boolean
        backchannel_logout_uri:
          type: string
        client_credentials_grant_access_token_lifespan:
          type: string
        client_id:
          type: string
        client_name:
          type: string
        client_secret:
          type: string
        client_secret_expires_at:
          format: int64
          type: string
        client_uri:
          type: string
        contacts:
          items:
            type: string
          type: array
        created_at:
          format: date-time
          type: string
        frontchannel_logout_session_required:
          type: boolean
        frontchannel_logout_uri:
          type: string
        grant_types:
          items:
            type: string
          type: array
        implicit_grant_access_token_lifespan:
          type: string
        implicit_grant_id_token_lifespan:
          type: string
        jwks:
          type: object
        jwks_uri:
          type: string
        jwt_bearer_grant_access_token_lifespan:
          type: string
        logo_uri:
          type: string
        metadata:
          type: object
        owner:
          type: string
        policy_uri:
          type: string
        post_logout_redirect_uris:
          items:
            type: string
          type: array
        redirect_uris:
          items:
            type: string
          type: array
        refresh_token_grant_access_token_lifespan:
          type: string
        refresh_token_grant_id_token_lifespan:
          type: string
        refresh_token_grant_refresh_token_lifespan:
          type: string
        registration_access_token:
          type: string
        registration_client_uri:
          type: string
        request_object_signing_alg:
          type: string
        request_uris:
          items:
            type: string
          type: array
        response_types:
          items:
            type: string
          type: array
        scope:
          type: string
        sector_identifier_uri:
          type: string
        skip_consent:
          type: boolean
        subject_type:
          type: string
        token_endpoint_auth_method:
          type: string
        token_endpoint_auth_signing_alg:
          type: string
        tos_uri:
          type: string
        updated_at:
          format: date-time
          type: string
        userinfo_signed_response_alg:
          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