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 Roles Service API

The RolesService API from Canonical — 5 operation(s) for rolesservice.

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

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

This API exposes 9 operations across 5 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

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

9 operations 5 paths 13 schemas 2 DELETE4 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1
Base URL
https://api.snapcraft.io
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Canonical Roles Service API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 3 scopes.

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 2 DELETE, 4 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

RolesService 9
GET
/api/v0/roles
Roles service list roles
RolesService_ListRoles → 200401403default
POST
/api/v0/roles
Roles service create role
RolesService_CreateRole body → 201401403default
DELETE
/api/v0/roles/{id}
Roles service remove role
RolesService_RemoveRole 1 param → 200401403default
GET
/api/v0/roles/{id}
Roles service get role
RolesService_GetRole 1 param → 200401403404default
PATCH
/api/v0/roles/{id}
Roles service update role
RolesService_UpdateRole 1 param body → 401403501default
GET
/api/v0/roles/{id}/entitlements
Roles service list role entitlements
RolesService_ListRoleEntitlements 2 params → 200401403default
PATCH
/api/v0/roles/{id}/entitlements
Roles service update role entitlements
RolesService_UpdateRoleEntitlements 1 param body → 200401403default
DELETE
/api/v0/roles/{id}/entitlements/{entitlementId}
Roles service remove role entitlement
RolesService_RemoveRoleEntitlement 2 params → 200401403default
GET
/api/v0/roles/{id}/groups
Roles service get role groups
RolesService_GetRoleGroups 1 param → 200401403default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are rolesGetRoleResp (4 properties), rolesGetRoleGroupsResp (4 properties), typesPagination (4 properties), rolesListRolesResp (4 properties). Each schema is shown below with its type and property counts.

typesPermissions
object
1 property
rolesListRoleEntitlementsResp
object
3 properties
typesPermission
object
2 properties
rolesRemoveRoleEntitlementResp
object
2 properties
typesPagination
object
4 properties
rolesGetRoleGroupsResp
object
4 properties
typesErrorResponse
object
2 properties
rolesUpdateRoleEntitlementsResp
object
2 properties
rolesListRolesResp
object
4 properties
rolesRemoveRoleResp
object
2 properties
rolesGetRoleResp
object
4 properties
rolesCreateRoleResp
object
4 properties
rolesRole
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-rolesservice-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 Roles Service 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.