dotCMS

dotCMS Roles API

User role and permission management

GitHub OpenAPI

Operations 19

GET /api/role/loadbyid/{params} Load role by ID (deprecated) #
GET /api/role/loadbyname/{params} Load roles by name filter (deprecated) #
GET /api/role/loadchildren/{params} Load role children (deprecated) #
GET /api/v1/roles Load root roles #
POST /api/v1/roles Create new role #
POST /api/v1/roles/{roleid}/users/{userId} Grant a role to a user #
GET /api/v1/roles/checkuserroles/userid/{userId}/roleids/{roleIds} Check user roles #
GET /api/v1/roles/{roleid} Load role by role ID #
PUT /api/v1/roles/{roleid} Update a role #
DELETE /api/v1/roles/{roleid} Delete a role #
GET /api/v1/roles/layouts Get all layouts #
POST /api/v1/roles/layouts Save role layouts #
DELETE /api/v1/roles/layouts Delete role layouts #
GET /api/v1/roles/{roleId}/layouts Find role layouts #
GET /api/v1/roles/users/{userIdOrEmail} Load user roles #
GET /api/v1/roles/{roleid}/rolehierarchyanduserroles Load users and roles by role ID #
GET /api/v1/roles/{roleid}/users Get the users directly granted a role #
DELETE /api/v1/roles/{roleid}/users Remove users from a role #
GET /api/v1/roles/_search Search Roles #

Documentation

📖
Documentation
https://dev.dotcms.com/docs/build/apis/api-basics/rest-apis
📖
APIReference
https://dev.dotcms.com/docs/build/apis/rest-apis/api-playground

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/openapi/dotcms-roles-api-openapi.yml

Other Resources

🔗
DeveloperPortal
https://dev.dotcms.com/
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/errors/dotcms-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/data-model/dotcms-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/conventions/dotcms-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/dotcms-roles-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dotcms-roles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: dotCMS REST Roles API
  version: '3'
  description: User role and permission management
servers:
- url: /
  description: dotCMS Server
tags:


# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/openapi/dotcms-roles-api-openapi.yml