The API of Canonical's Identity Platform — an OIDC/OAuth 2.0 identity provider built on Ory and delivered as a Juju charm bundle. Covers identities, clients, schemas, providers, roles, groups, rules and entitlements. Canonical publishes an OpenAPI 3.0.3 contract with 45 paths and 79 operations, plus a gRPC-gateway swagger form in the same repository.
Canonical Identity Platform API is one of 22 APIs that Canonical publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Identity, OIDC, and Authentication. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
79 operations
across 45 paths,
organized into 12 resource areas,
and defines 113 schemas.
It is described by OpenAPI 3.0.3, at version 0.1.
79 operations45 paths113 schemas16 DELETE36 GET9 PATCH13 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Canonical Identity Platform API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 3 scopes.
Paths & Operations 79
Across 45 paths, the API surfaces 79 operations — 16 DELETE, 36 GET, 9 PATCH, 13 POST, 5 PUT. They span 12 resource areas, including AuthenticationService, AppAuthorizationService, AuthzGroupsService, ClientsService, GroupsService, IdentitiesService, IdpsService, TenantService, and 4 more. Each is listed below with its method, path, parameters, and response codes.
The contract defines 113 schemas that model the data the API accepts and returns. The most detailed are clientsClient (47 properties), idpsUpdateIdpBody (16 properties), idpsCreateIdpBody (16 properties), idpsIdp (16 properties). Each schema is shown below with its type and property counts.
TenantServiceInviteMemberBody
object
2 properties
TenantServiceProvisionUserBody
object
2 properties
TenantServiceUpdateTenantBody
object
2 properties
TenantServiceUpdateTenantUserBody
object
1 property
apiauthorizationGroup
object
1 property
apiauthz_groupsCreateGroupResp
object
3 properties
apiauthz_groupsGetGroupResp
object
3 properties
apiauthz_groupsGroup
object
7 properties
apiauthz_groupsListGroupsResp
object
4 properties
apiauthz_groupsRemoveGroupResp
object
2 properties
apiauthz_groupsUpdateGroupResp
object
3 properties
apigroupsCreateGroupResp
object
4 properties
apigroupsGetGroupResp
object
4 properties
apigroupsGroup
object
2 properties
apigroupsListGroupsResp
object
4 properties
apigroupsRemoveGroupResp
object
2 properties
apigroupsUpdateGroupResp
object
apischemasSchema
object
3 properties
apistatusStatus
object
2 properties
authenticationMeResp
object
5 properties
authorizationAddAllowedAppToGroupResp
object
2 properties
authorizationApp
object
1 property
authorizationGetAllowedAppsInGroupResp
object
3 properties
authorizationGetAllowedGroupsForAppResp
object
3 properties
authorizationRemoveAllowedAppFromGroupResp
object
2 properties
authorizationRemoveAllowedAppsFromGroupResp
object
2 properties
authorizationRemoveAllowedGroupsForAppResp
object
2 properties
authz_groupsAddUserToGroupsResp
object
2 properties
authz_groupsAddUsersToGroupResp
object
2 properties
authz_groupsGroupInput
object
3 properties
authz_groupsListUserGroupsResp
object
4 properties
authz_groupsListUsersInGroupResp
object
4 properties
authz_groupsRemoveUserFromGroupResp
object
2 properties
authz_groupsUser
object
4 properties
clientsClient
object
47 properties
clientsCreateClientResp
object
3 properties
clientsGetClientResp
object
3 properties
clientsListClientsResp
object
4 properties
clientsRemoveClientResp
object
2 properties
clientsUpdateClientResp
object
3 properties
googlerpcStatus
object
3 properties
groupsGetGroupIdentitiesResp
object
4 properties
groupsGetGroupRolesResp
object
4 properties
groupsIdentities
object
1 property
groupsListGroupEntitlementsResp
object
3 properties
groupsRemoveGroupEntitlementResp
object
2 properties
groupsRemoveGroupIdentityResp
object
2 properties
groupsRemoveGroupRoleResp
object
2 properties
groupsRoles
object
1 property
groupsUpdateGroupEntitlementsResp
object
2 properties
groupsUpdateGroupIdentitiesResp
object
2 properties
groupsUpdateGroupRolesResp
object
2 properties
identitiesCreateIdentityBody
object
9 properties
identitiesCreateIdentityResp
object
4 properties
identitiesGetIdentityResp
object
4 properties
identitiesIdentity
object
15 properties
identitiesIdentityCredentials
object
7 properties
identitiesListIdentitiesResp
object
4 properties
identitiesNullableString
object
2 properties
identitiesRecoveryIdentityAddress
object
6 properties
identitiesRemoveIdentityResp
object
3 properties
identitiesUpdateIdentityBody
object
7 properties
identitiesUpdateIdentityResp
object
4 properties
identitiesVerifiableIdentityAddress
object
9 properties
idpsCreateIdpBody
object
16 properties
idpsCreateIdpResp
object
3 properties
idpsGetIdpResp
object
3 properties
idpsIdp
object
16 properties
idpsListIdpsResp
object
3 properties
idpsRemoveIdpResp
object
2 properties
idpsUpdateIdpBody
object
16 properties
idpsUpdateIdpResp
object
3 properties
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
protobufNullValue
string
NullValue is a singleton enumeration to represent the null value for the Value type union. The JSON representation for NullValue is JSON null. - NULLVALUE: Nul…
rolesCreateRoleResp
object
4 properties
rolesGetRoleGroupsResp
object
4 properties
rolesGetRoleResp
object
4 properties
rolesListRoleEntitlementsResp
object
3 properties
rolesListRolesResp
object
4 properties
rolesRemoveRoleEntitlementResp
object
2 properties
rolesRemoveRoleResp
object
2 properties
rolesRole
object
2 properties
rolesUpdateRoleEntitlementsResp
object
2 properties
rolesUpdateRoleResp
object
schemasCreateSchemaResp
object
3 properties
schemasDefaultSchema
object
1 property
schemasGetDefaultSchemaResp
object
3 properties
schemasGetSchemaResp
object
3 properties
schemasListSchemasResp
object
4 properties
schemasRemoveSchemaResp
object
2 properties
schemasUpdateDefaultSchemaResp
object
3 properties
schemasUpdateSchemaResp
object
3 properties
statusBuildInfo
object
3 properties
tenantCreateTenantRequest
object
1 property
tenantCreateTenantResponse
object
1 property
tenantDeleteTenantResponse
object
2 properties
tenantInviteMemberResponse
object
3 properties
tenantListMyTenantsResponse
object
1 property
tenantListTenantUsersResponse
object
2 properties
tenantListTenantsResponse
object
2 properties
tenantListUserTenantsResponse
object
1 property
tenantLookupTenantsResponse
object
1 property
tenantProvisionUserResponse
object
1 property
tenantTenant
object
4 properties
tenantTenantInput
object
2 properties
tenantTenantUser
object
3 properties
tenantUpdateTenantResponse
object
1 property
tenantUpdateTenantUserResponse
object
1 property
typesErrorResponse
object
2 properties
typesPagination
object
4 properties
typesPaginationInput
object
2 properties
typesPermission
object
2 properties
typesPermissions
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Canonical Identity Platform 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.
