Canonical

Canonical Identity Provider Groups API

The identity_provider_groups API from Canonical — 3 operation(s) for identity_provider_groups.

GitHub OpenAPI

Operations 8

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 /1.0/auth/identity-provider-groups List identity provider groups as URLs · Get the identity provider groups #
Ask an LLM
“Which identity provider groups are mapped in LXD?”
“Can I get just the URLs of my IdP group mappings?”
Tell an agent
List the URLs of all identity provider groups.
Show identity provider group links configured in LXD.
POST /1.0/auth/identity-provider-groups Create an identity provider group mapping · Create a new identity provider group #
Ask an LLM
“How do I map a group from my identity provider onto LXD groups?”
“Can one IdP group be mapped to several LXD authorization groups?”
Tell an agent
Create identity provider group {name}.
Map IdP group {name} to LXD groups {groups}.
DELETE /1.0/auth/identity-provider-groups/{idpGroupName} Delete an identity provider group · Delete the identity provider group #
Ask an LLM
“How do I remove an IdP group mapping from LXD?”
“Does deleting an identity provider group delete the LXD groups it maps to?”
Tell an agent destructive · confirm first
Delete identity provider group {idpGroupName}.
Remove the IdP group mapping from LXD.
GET /1.0/auth/identity-provider-groups/{idpGroupName} Get an identity provider group · Get the identity provider group #
Ask an LLM
“Which LXD groups is a particular IdP group mapped to?”
“What does one identity provider group mapping contain?”
Tell an agent
Show identity provider group {idpGroupName} and its mapped groups.
Get the mapping for this IdP group.
PATCH /1.0/auth/identity-provider-groups/{idpGroupName} Add groups to an IdP group mapping · Partially update the identity provider group #
Ask an LLM
“Can I add one more LXD group to an existing IdP mapping without replacing it?”
“How do I partially update an identity provider group?”
Tell an agent
Patch IdP group mapping {idpGroupName} to include groups {groups}.
Partially update the identity provider group with {groups}.
POST /1.0/auth/identity-provider-groups/{idpGroupName} Rename an identity provider group · Rename the identity provider group #
Ask an LLM
“Can I rename an identity provider group mapping in LXD?”
“What happens to the mapping when an IdP group gets a new name?”
Tell an agent
Rename identity provider group {idpGroupName} to {name}.
Give this IdP group mapping the new name {name}.
PUT /1.0/auth/identity-provider-groups/{idpGroupName} Replace an IdP group's mapped groups · Update the identity provider group #
Ask an LLM
“How do I overwrite the full list of LXD groups an IdP group maps to?”
“Will replacing the mapping remove groups I leave out?”
Tell an agent
Replace the mapped groups of IdP group {idpGroupName} with {groups}.
Set the full group mapping of the identity provider group to exactly {groups}.
GET /1.0/auth/identity-provider-groups?recursion=1 List identity provider groups with mappings · Get the groups #
Ask an LLM
“How do I see every IdP group together with the LXD groups it maps to?”
“Can I get full identity provider group objects in one call?”
Tell an agent
List all identity provider groups with their group mappings.
Get expanded IdP group records.

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-identity-provider-groups-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-identity-provider-group-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-identity-provider-groups-post-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-identity-provider-group-put-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-identity-provider-group-post-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-identity-provider-groups-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-identity-provider-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: lxd@lists.canonical.com
    name: LXD upstream
    url: https://github.com/canonical/lxd
  description: 'This is the REST API used by all LXD clients.

    Internal endpoints aren''t included in this documentation.


    The LXD API is available over both a local unix+http and remote https API.

    Authentication for local users relies on group membership and access to the unix socket.

    For remote users, the default authentication method is TLS client.'
  license:
    name: AGPL-3.0-only
    url: https://www.gnu.org/licenses/agpl-3.0.en.html
  title: LXD external REST Identity Provider Groups API
  version: '1.0'
tags:
- name: identity_provider_groups
paths:
  /1.0/auth/identity-provider-groups:
    get:
      description: Returns a list of identity provider groups (URLs).
      operationId: identity_provider_groups_get
      responses:
        '200':
          description: API endpoints
          content:
            application/json:
              schema:
                description: Sync response
                properties:
                  metadata:
                    description: List of endpoints
                    example: "[\n  \"/1.0/auth/identity-provider-groups/sales\",\n  \"/1.0/auth/identity-provider-groups/operations\"\n]"
                    items:
                      type: string
                    type: array
                  status:
                    description: Status description
                    example: Success
                    type: string
                  status_code:
                    description: Status code
                    example: 200
                    type: integer
                  type:
                    description: Response type
                    example: sync
                    type: string
                type: object
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get the identity provider groups
      tags:
      - identity_provider_groups
    post:
      description: Creates a new identity provider group.
      operationId: identity_provider_groups_post
      responses:
        '200':
          $ref: '#/components/responses/EmptySyncResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Create a new identity provider group
      tags:
      - identity_provider_groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderGroupsPost'
        description: Identity provider request
        required: true
  /1.0/auth/identity-provider-groups/{idpGroupName}:
    delete:
      description: Deletes the identity provider group
      operationId: identity_provider_group_delete
      responses:
        '200':
          $ref: '#/components/responses/EmptySyncResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Delete the identity provider group
      tags:
      - identity_provider_groups
    get:
      description: Gets a specific identity provider group.
      operationId: identity_provider_group_get
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                description: Sync response
                properties:
                  metadata:
                    $ref: '#/components/schemas/IdentityProviderGroup'
                  status:
                    description: Status description
                    example: Success
                    type: string
                  status_code:
                    description: Status code
                    example: 200
                    type: integer
                  type:
                    description: Response type
                    example: sync
                    type: string
                type: object
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get the identity provider group
      tags:
      - identity_provider_groups
    patch:
      description: Updates the editable fields of an identity provider group
      operationId: identity_provider_group_patch
      responses:
        '200':
          $ref: '#/components/responses/EmptySyncResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Partially update the identity provider group
      tags:
      - identity_provider_groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderGroupPut'
        description: Update request
    post:
      description: Renames the identity provider group
      operationId: identity_provider_group_post
      responses:
        '200':
          $ref: '#/components/responses/EmptySyncResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Rename the identity provider group
      tags:
      - identity_provider_groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderGroupPost'
        description: Update request
    put:
      description: Replaces the editable fields of an identity provider group
      operationId: identity_provider_group_put
      responses:
        '200':
          $ref: '#/components/responses/EmptySyncResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Update the identity provider group
      tags:
      - identity_provider_groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderGroupPut'
        description: Update request
  /1.0/auth/identity-provider-groups?recursion=1:
    get:
      description: Returns a list of identity provider groups.
      operationId: identity_provider_groups_get_recursion1
      responses:
        '200':
          description: API endpoints
          content:
            application/json:
              schema:
                description: Sync response
                properties:
                  metadata:
                    description: List of identity provider groups
                    items:
                      $ref: '#/components/schemas/IdentityProviderGroup'
                    type: array
                  status:
                    description: Status description
                    example: Success
                    type: string
                  status_code:
                    description: Status code
                    example: 200
                    type: integer
                  type:
                    description: Response type
                    example: sync
                    type: string
                type: object
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get the groups
      tags:
      - identity_provider_groups
components:
  schemas:
    IdentityProviderGroupsPost:
      properties:
        groups:
          description: Groups are the groups the IdP group resolves to.
          example:
          - foo
          - bar
          items:
            type: string
          type: array
          x-go-name: Groups
        name:
          description: Name is the name of the IdP group.
          type: string
          x-go-name: Name
      title: IdentityProviderGroupsPost is used for creating an IdentityProviderGroup.
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
    IdentityProviderGroupPost:
      properties:
        name:
          description: Name is the name of the IdP group.
          type: string
          x-go-name: Name
      title: IdentityProviderGroupPost is used for renaming an IdentityProviderGroup.
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
    IdentityProviderGroup:
      properties:
        access_entitlements:
          description: AccessEntitlements represents the entitlements that are granted to the requesting user on the attached entity.
          example:
          - can_view
          - can_edit
          items:
            type: string
          type: array
          x-go-name: AccessEntitlements
        groups:
          description: Groups are the groups the IdP group resolves to.
          example:
          - foo
          - bar
          items:
            type: string
          type: array
          x-go-name: Groups
        name:
          description: Name is the name of the IdP group.
          type: string
          x-go-name: Name
      title: IdentityProviderGroup represents a mapping between LXD groups and groups defined by an identity provider.
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
    IdentityProviderGroupPut:
      properties:
        groups:
          description: Groups are the groups the IdP group resolves to.
          example:
          - foo
          - bar
          items:
            type: string
          type: array
          x-go-name: Groups
      title: IdentityProviderGroupPut contains the editable fields of an IdentityProviderGroup.
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              error:
                example: bad request
                type: string
                x-go-name: Error
              error_code:
                example: 400
                format: int64
                type: integer
                x-go-name: ErrorCode
              type:
                example: error
                type: string
                x-go-name: Type
            type: object
    EmptySyncResponse:
      description: Empty sync response
      content:
        application/json:
          schema:
            properties:
              status:
                example: Success
                type: string
                x-go-name: Status
              status_code:
                example: 200
                format: int64
                type: integer
                x-go-name: StatusCode
              type:
                example: sync
                type: string
                x-go-name: Type
            type: object
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            properties:
              error:
                example: not authorized
                type: string
                x-go-name: Error
              error_code:
                example: 403
                format: int64
                type: integer
                x-go-name: ErrorCode
              type:
                example: error
                type: string
                x-go-name: Type
            type: object
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            properties:
              error:
                example: internal server error
                type: string
                x-go-name: Error
              error_code:
                example: 500
                format: int64
                type: integer
                x-go-name: ErrorCode
              type:
                example: error
                type: string
                x-go-name: Type
            type: object