Skip to main content

How does it work?

This module expose API Rest endpoint for Decidim. It uses secure workflows from OAuth2.0, leveraging the famous doorkeeper and devise gem.

This module:

  • Manages from system administration new client credential
  • Supports machine-to-machine and user tokens

It exposes for now only a set of endpoints, but the goal of this module is to support all the resources and actions available in Decidim. (See Supported Resources)

Authentication flows

Machine-to-machine flow (Client Credential Flow):

Client Credentials

User token flow (Resource Owner Password Credential Flow)

ROPC

Supported Resources

ScopesResourceSupported operations
systemorganizationsRead
publicsearchRead
spacesassemblies-
spacesparticipatory_processes-
spacesconferences-
componentscomponents-
proposalsproposals-
proposalsproposal_drafts-
proposalsproposal_amendments-
proposalsproposal_comments-
proposalsproposal_votes-
info

Each scope has its sets of fine-grained permissions, allowing to cherry-pick what the authenticated system can do in the Decidim application.