How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canonical Identities API

The identities API from Canonical — 15 operation(s) for identities.

Canonical Identities API is one of 122 APIs that Canonical publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Identities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and release notes.

This API exposes 28 operations across 15 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against the base URL https://api.snapcraft.io.

28 operations 15 paths 11 schemas 4 DELETE13 GET3 PATCH5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.snapcraft.io
Resource Areas
1

Paths & Operations 28

Across 15 paths, the API surfaces 28 operations — 4 DELETE, 13 GET, 3 PATCH, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Identities 28
GET
/1.0/auth/identities
Get the identities
identities_get → 200403500
GET
/1.0/auth/identities/bearer
Get the bearer identities
identities_get_bearer → 200403500
POST
/1.0/auth/identities/bearer
Add a bearer identity
identities_post_bearer body → 201400403500
DELETE
/1.0/auth/identities/bearer/{nameOrID}/token
Revoke a bearer identity token
identity_delete_bearer_token → 403404500
POST
/1.0/auth/identities/bearer/{nameOrID}/token
Issue a token for a bearer identity
identity_post_bearer_token body → 200400403404500
DELETE
/1.0/auth/identities/bearer/{nameOrIdentifier}
Delete the bearer identity
identity_delete_bearer → 200400403500501
GET
/1.0/auth/identities/bearer/{nameOrIdentifier}
Get the bearer identity
identity_get_bearer → 200403500
PATCH
/1.0/auth/identities/bearer/{nameOrIdentifier}
Partially update the bearer identity
identity_patch_bearer body → 200400403412500501
PUT
/1.0/auth/identities/bearer/{nameOrIdentifier}
Update the bearer identity
identity_put_bearer body → 200400403412500501
GET
/1.0/auth/identities/bearer?recursion=1
Get the bearer identities
identities_get_bearer_recursion1 → 200403500
GET
/1.0/auth/identities/current
Get the current identity
identity_get_current → 200403500
GET
/1.0/auth/identities/oidc
Get the OIDC identities
identities_get_oidc → 200403500
DELETE
/1.0/auth/identities/oidc/{nameOrIdentifier}
Delete the OIDC identity
identity_delete_oidc → 200400403500501
GET
/1.0/auth/identities/oidc/{nameOrIdentifier}
Get the OIDC identity
identity_get_oidc → 200403500
PATCH
/1.0/auth/identities/oidc/{nameOrIdentifier}
Partially update the OIDC identity
identity_patch_oidc body → 200400403412500501
PUT
/1.0/auth/identities/oidc/{nameOrIdentifier}
Update the OIDC identity
identity_put_oidc body → 200400403412500501
GET
/1.0/auth/identities/oidc?recursion=1
Get the OIDC identities
identities_get_oidc_recursion1 → 200403500
GET
/1.0/auth/identities/tls
Get the TLS identities
identities_get_tls → 200403500
POST
/1.0/auth/identities/tls
Add a TLS identity
identities_post_tls body → 201400403500
DELETE
/1.0/auth/identities/tls/{nameOrIdentifier}
Delete the TLS identity
identity_delete_tls → 200400403500501
GET
/1.0/auth/identities/tls/{nameOrIdentifier}
Get the TLS identity
identity_get_tls → 200403500
PATCH
/1.0/auth/identities/tls/{nameOrIdentifier}
Partially update the TLS identity
identity_patch_tls body → 200400403412500501
PUT
/1.0/auth/identities/tls/{nameOrIdentifier}
Update the TLS identity
identity_put_tls body → 200400403412500501
POST
/1.0/auth/identities/tls?public
Add a TLS identity
identities_post_tls_untrusted body → 201400403500
GET
/1.0/auth/identities/tls?recursion=1
Get the TLS identities
identities_get_tls_recursion1 → 200403500
GET
/1.0/auth/identities?recursion=1
Get the identities
identities_get_recursion1 → 200403500
GET
/v1/identities
Get all identities
getV1Identities → 200
POST
/v1/identities
Manage identities
postV1Identities body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are IdentityInfo (11 properties), Identity (8 properties), IdentitiesTLSPost (5 properties), identity (3 properties). Each schema is shown below with its type and property counts.

Permission
object
3 properties
IdentityInfo
object
These fields can only be evaluated for the currently authenticated identity.
11 properties
IdentityBearerToken
object
IdentityBearerToken contains a token issued for an identity whose authentication method is api.AuthenticationMethodBearer.
1 property
IdentitiesTLSPost
object
5 properties
IdentityPut
object
2 properties
Identity
object
8 properties
IdentityBearerTokenPost
object
1 property
IdentitiesBearerPost
object
3 properties
BaseResponse
object
3 properties
identity
object
3 properties
GetIdentitiesResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-identities-api-openapi.yml Raw ↑

Other APIs Canonical publishes across the network.

Snap Store API
Charmhub API
MAAS API
Juju Client / Controller API
Launchpad Web Services API
Ubuntu Pro Client API
Canonical Assertions API
Canonical Search API
Canonical Snaps API
MicroCeph REST API
Canonical App Authorization Service API
Canonical Application API
Where this information came from

This is an independent, third-party profile of Canonical Identities API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.