Liferay

Liferay DXP is an open-source digital experience platform offering headless REST APIs for managing users, roles, permissions, content, and site configuration. The Roles API lets you list, retrieve, and associate or dissociate regular, site, and organization roles for users.

1 APIs 0 Features

Open SourceDigital ExperienceDXPRolesUsersPermissionsHeadless

APIs

Liferay Roles API

Liferay's headless admin user Roles API. Create and manage roles via REST: list and retrieve roles, and associate or dissociate users to regular, site, and organization roles.

Collections

Liferay Roles API

OPEN

Pricing Plans

Liferay Plans Pricing

3 plans

PLANS

Rate Limits

Liferay Rate Limits

5 limits

RATE LIMITS

FinOps

Liferay Finops

FINOPS

Resources

👥

GitHubOrganization

GitHubOrganization

🔗

LinkedIn

Sources

opencollection: 1.0.0
info:
  name: Liferay Roles API
  version: v1.0
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Roles
    type: folder
  items:
  - info:
      name: List roles
      type: http
    http:
      method: GET
      url: http://localhost:8080/o/headless-admin-user/v1.0/roles
    docs: Returns the collection of roles available in Liferay.
  - info:
      name: Get a role
      type: http
    http:
      method: GET
      url: http://localhost:8080/o/headless-admin-user/v1.0/roles/:roleId
      params:
      - name: roleId
        value: ''
        type: path
    docs: Returns a single role identified by its ID.
  - info:
      name: Associate a regular role to a user
      type: http
    http:
      method: POST
      url: http://localhost:8080/o/headless-admin-user/v1.0/roles/:roleId/association/user-account/:userId
      params:
      - name: roleId
        value: ''
        type: path
      - name: userId
        value: ''
        type: path
    docs: Associate a regular role to a user
  - info:
      name: Remove regular role association from a user
      type: http
    http:
      method: DELETE
      url: http://localhost:8080/o/headless-admin-user/v1.0/roles/:roleId/association/user-account/:userId
      params:
      - name: roleId
        value: ''
        type: path
      - name: userId
        value: ''
        type: path
    docs: Remove regular role association from a user
  - info:
      name: Associate a site role to a user
      type: http
    http:
      method: POST
      url: http://localhost:8080/o/headless-admin-user/v1.0/roles/:roleId/association/user-account/:userId/site/:siteId
      params:
      - name: roleId
        value: ''
        type: path
      - name: userId
        value: ''
        type: path
      - name: siteId
        value: ''
        type: path
    docs: Associate a site role to a user
  - info:
      name: Remove site role association from a user
      type: http
    http:
      method: DELETE
      url: http://localhost:8080/o/headless-admin-user/v1.0/roles/:roleId/association/user-account/:userId/site/:siteId
      params:
      - name: roleId
        value: ''
        type: path
      - name: userId
        value: ''
        type: path
      - name: siteId
        value: ''
        type: path
    docs: Remove site role association from a user
  - info:
      name: Associate an organization role to a user
      type: http
    http:
      method: POST
      url: http://localhost:8080/o/headless-admin-user/v1.0/roles/:roleId/association/user-account/:userId/organization/:orgId
      params:
      - name: roleId
        value: ''
        type: path
      - name: userId
        value: ''
        type: path
      - name: orgId
        value: ''
        type: path
    docs: Associate an organization role to a user
  - info:
      name: Remove organization role association from a user
      type: http
    http:
      method: DELETE
      url: http://localhost:8080/o/headless-admin-user/v1.0/roles/:roleId/association/user-account/:userId/organization/:orgId
      params:
      - name: roleId
        value: ''
        type: path
      - name: userId
        value: ''
        type: path
      - name: orgId
        value: ''
        type: path
    docs: Remove organization role association from a user
bundled: true