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

The GroupsService API from Canonical — 8 operation(s) for groupsservice.

Canonical Groups 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 GroupsService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and release notes.

This API exposes 14 operations across 8 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

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

14 operations 8 paths 20 schemas 4 DELETE5 GET3 PATCH2 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 Groups Service API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 3 scopes.

Paths & Operations 14

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

GroupsService 14
GET
/api/v0/groups
Groups service list groups
GroupsService_ListGroups → 200401403default
POST
/api/v0/groups
Groups service create group
GroupsService_CreateGroup body → 201400401403default
DELETE
/api/v0/groups/{id}
Groups service remove group
GroupsService_RemoveGroup 1 param → 200401403default
GET
/api/v0/groups/{id}
Groups service get group
GroupsService_GetGroup 1 param → 200401403default
PATCH
/api/v0/groups/{id}
Groups service update group
GroupsService_UpdateGroup 1 param body → 401403501default
GET
/api/v0/groups/{id}/entitlements
Groups service list group entitlements
GroupsService_ListGroupEntitlements 2 params → 200401403default
PATCH
/api/v0/groups/{id}/entitlements
Groups service update group entitlements
GroupsService_UpdateGroupEntitlements 1 param body → 201400401403default
DELETE
/api/v0/groups/{id}/entitlements/{entitlementId}
Groups service remove group entitlement
GroupsService_RemoveGroupEntitlement 2 params → 200400401403default
GET
/api/v0/groups/{id}/identities
Groups service get group identities
GroupsService_GetGroupIdentities 1 param → 200401403default
PATCH
/api/v0/groups/{id}/identities
Groups service update group identities
GroupsService_UpdateGroupIdentities 1 param body → 201400401403default
DELETE
/api/v0/groups/{id}/identities/{identityId}
Groups service remove group identity
GroupsService_RemoveGroupIdentity 2 params → 200401403default
GET
/api/v0/groups/{id}/roles
Groups service get group roles
GroupsService_GetGroupRoles 1 param → 200401403default
POST
/api/v0/groups/{id}/roles
Groups service update group roles
GroupsService_UpdateGroupRoles 1 param body → 201400401403default
DELETE
/api/v0/groups/{id}/roles/{roleId}
Groups service remove group role
GroupsService_RemoveGroupRole 2 params → 200401403default

Schemas 20

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

apigroupsRemoveGroupResp
object
2 properties
groupsIdentities
object
1 property
groupsRoles
object
1 property
typesErrorResponse
object
2 properties
typesPermissions
object
1 property
apigroupsGetGroupResp
object
4 properties
groupsGetGroupIdentitiesResp
object
4 properties
typesPermission
object
2 properties
groupsGetGroupRolesResp
object
4 properties
groupsUpdateGroupRolesResp
object
2 properties
apigroupsGroup
object
2 properties
groupsRemoveGroupIdentityResp
object
2 properties
groupsUpdateGroupIdentitiesResp
object
2 properties
apigroupsListGroupsResp
object
4 properties
apigroupsCreateGroupResp
object
4 properties
groupsListGroupEntitlementsResp
object
3 properties
groupsUpdateGroupEntitlementsResp
object
2 properties
groupsRemoveGroupRoleResp
object
2 properties
typesPagination
object
4 properties
groupsRemoveGroupEntitlementResp
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-groupsservice-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 Groups 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.