> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Liferay

> How to set up the Liferay connector, plus the actions and events that are available.

![Liferay](https://stackone-logos.com/api/liferay/filled/svg)

v1.2.0[See changelog](https://docs.stackone.com/connectors/liferay/changelog.md)

[104 actions](#actions) · [10 events](#events) · 2 auth methods

CMS
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/liferay/guides/connector-profile/oauth-2-0.md)
>
> Authenticate with your Liferay instance using OAuth 2.0. Requires an OAuth2 application registered in Liferay's OAuth2 A...

> [card] [OAuth 2.0 - Client Credentials · Connector Profile](https://docs.stackone.com/connectors/liferay/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Authenticate with your Liferay instance using OAuth 2.0 Client Credentials. Requires a Headless Server OAuth2 applicatio...

Optionally, configure receiving Events for Liferay into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/liferay/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/liferay/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 - Client Credentials · Link Account](https://docs.stackone.com/connectors/liferay/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

Liferay.Headless.Admin.Taxonomy.everything.read

Liferay.Headless.Admin.User.everything

Liferay.Headless.Admin.User.everything.read

Liferay.Headless.Delivery.everything

Liferay.Headless.Delivery.everything.read

No scopes found

104 actions

ActionDescriptionRequired scopes

List Accounts`liferay_list_accounts`

Retrieve a paginated list of B2B business accounts (companies/organizations) from Liferay. NOT for looking up individual...

`Liferay.Headless.Admin.User.everything.read`

Get Account`liferay_get_account`

Retrieve an account by ID

`Liferay.Headless.Admin.User.everything.read`

Get Account By External Reference Code`liferay_get_account_by_external_reference_code`

Retrieve a business account by its external reference code (ERC), a system-assigned sync identifier — NOT the account/co...

`Liferay.Headless.Admin.User.everything.read`

Create Account`liferay_create_account`

Create a new business account in Liferay

`Liferay.Headless.Admin.User.everything`

List Account User Accounts`liferay_list_account_user_accounts`

List users assigned to an account

`Liferay.Headless.Admin.User.everything.read`

Assign User To Account`liferay_assign_user_to_account`

Assign an existing user to a business account by their exact email address. Both inputs must come from prior list/lookup...

`Liferay.Headless.Admin.User.everything`

Remove User From Account`liferay_remove_user_from_account`

Remove a user from an account by email address. Returns 404 when the user is not currently assigned to the specified acc...

`Liferay.Headless.Admin.User.everything`

List Account Roles`liferay_list_account_roles`

List account-scoped roles on an account

`Liferay.Headless.Admin.User.everything.read`

Assign Account Role To User`liferay_assign_account_role_to_user`

Assign an account-scoped role to a user using numeric IDs (accountId, accountRoleId, userAccountId)

`Liferay.Headless.Admin.User.everything`

Update Account`liferay_patch_account`

Update an existing business account

`Liferay.Headless.Admin.User.everything`

Delete Account`liferay_delete_account`

Delete an account by ID

`Liferay.Headless.Admin.User.everything`

List Blog Postings`liferay_list_blog_postings`

Retrieve a paginated list of blog postings for a site. PREFERRED tool when the user asks to "list posts", "confirm a pos...

`Liferay.Headless.Delivery.everything.read`

Get Blog Posting`liferay_get_blog_posting`

Retrieve a single blog posting by ID

`Liferay.Headless.Delivery.everything.read`

Create Blog Posting`liferay_create_blog_posting`

Create a new blog posting for a site

`Liferay.Headless.Delivery.everything`

Update Blog Posting`liferay_patch_blog_posting`

Update an existing blog posting

`Liferay.Headless.Delivery.everything`

Delete Blog Posting`liferay_delete_blog_posting`

Delete a blog posting by ID

`Liferay.Headless.Delivery.everything`

List Blog Posting Comments`liferay_list_blog_posting_comments`

Retrieve comments on a blog posting

`Liferay.Headless.Delivery.everything.read`

Create Blog Posting Comment`liferay_create_blog_posting_comment`

Add a comment to a blog posting

`Liferay.Headless.Delivery.everything`

Create Structured Content Comment`liferay_create_structured_content_comment`

Add a comment to a structured content article

`Liferay.Headless.Delivery.everything`

List Structured Content Comments`liferay_list_structured_content_comments`

List comments on a structured content article

`Liferay.Headless.Delivery.everything.read`

Create Document Comment`liferay_create_document_comment`

Add a comment to a document

`Liferay.Headless.Delivery.everything`

Get Comment`liferay_get_comment`

Retrieve a comment by ID

`Liferay.Headless.Delivery.everything.read`

Replace Comment`liferay_replace_comment`

Replace a comment's contents (full replacement)

`Liferay.Headless.Delivery.everything`

Delete Comment`liferay_delete_comment`

Delete a comment by ID

`Liferay.Headless.Delivery.everything`

List Comment Replies`liferay_list_comment_replies`

Retrieve replies to a comment

`Liferay.Headless.Delivery.everything.read`

Create Comment Reply`liferay_create_comment_reply`

Reply to a comment

`Liferay.Headless.Delivery.everything`

List Document Comments`liferay_list_document_comments`

Retrieve comments on a document

`Liferay.Headless.Delivery.everything.read`

List Content Structures`liferay_list_content_structures`

Retrieve a paginated list of content structures (templates) for a site

`Liferay.Headless.Delivery.everything.read`

Get Content Structure`liferay_get_content_structure`

Retrieve a content structure by ID

`Liferay.Headless.Delivery.everything.read`

List Document Folders`liferay_list_document_folders`

Retrieve a paginated list of document folders for a site

`Liferay.Headless.Delivery.everything.read`

Get Document Folder`liferay_get_document_folder`

Retrieve a document folder by ID

`Liferay.Headless.Delivery.everything.read`

Create Document Folder`liferay_create_document_folder`

Create a new document folder in a site

`Liferay.Headless.Delivery.everything`

Update Document Folder`liferay_patch_document_folder`

Update an existing document folder

`Liferay.Headless.Delivery.everything`

List Document Folder Subfolders`liferay_list_document_folder_subfolders`

List subfolders of a document folder

`Liferay.Headless.Delivery.everything.read`

List Document Folder Documents`liferay_list_document_folder_documents`

List documents inside a document folder

`Liferay.Headless.Delivery.everything.read`

Delete Document Folder`liferay_delete_document_folder`

Delete a document folder by ID

`Liferay.Headless.Delivery.everything`

List Documents`liferay_list_documents`

Retrieve a paginated list of documents for a site

`Liferay.Headless.Delivery.everything.read`

Get Document`liferay_get_document`

Retrieve a document by ID

`Liferay.Headless.Delivery.everything.read`

Create Document`liferay_create_document`

Upload a new document to a site

`Liferay.Headless.Delivery.everything`

Create Document In Folder`liferay_create_document_in_folder`

Upload a new document to a specific folder

`Liferay.Headless.Delivery.everything`

Update Document`liferay_patch_document`

Replace a document's file and optionally update metadata

`Liferay.Headless.Delivery.everything`

Delete Document`liferay_delete_document`

Delete a document by ID

`Liferay.Headless.Delivery.everything`

Get Unified Credentials`liferay_unified_get_me`

Return the authenticated Liferay identity for the current connection, mapped to the IAM unified credentials schema. Call...

`Liferay.Headless.Admin.User.everything.read`

IAM Auth Test`liferay_auth_test`

Validate the current Liferay OAuth token and return the raw, unmapped /my-user-account JSON. Bypasses the unified IAM cr...

`Liferay.Headless.Admin.User.everything.read`

List Unified Groups`liferay_unified_list_groups`

List Liferay user groups mapped to the IAM unified group schema. Liferay user groups are flat collaboration groups with...

`Liferay.Headless.Admin.User.everything.read`

Get Unified Group`liferay_unified_get_group`

Retrieve a single Liferay user group by id, mapped to the IAM unified group schema.

`Liferay.Headless.Admin.User.everything.read`

List Unified Organizations`liferay_unified_list_organizations`

List Liferay organizations mapped to the IAM unified organization schema. Always requests the full organization hierarch...

`Liferay.Headless.Admin.User.everything.read`

Get Unified Organization`liferay_unified_get_organization`

Retrieve a single Liferay organization by id, mapped to the IAM unified organization schema.

`Liferay.Headless.Admin.User.everything.read`

List Unified Resource Types`liferay_unified_list_resource_types`

List unified resource types in Liferay.

`Liferay.Headless.Admin.User.everything.read`

List Unified Resource Users`liferay_unified_list_resource_users`

List unified resource users in Liferay.

`Liferay.Headless.Admin.User.everything.read`

List Unified Roles`liferay_unified_list_roles`

List Liferay roles mapped to the IAM unified role schema. Includes regular, site, organization, and account-scoped roles...

`Liferay.Headless.Admin.User.everything.read`

Get Unified Role`liferay_unified_get_role`

Retrieve a single Liferay role by id, mapped to the IAM unified role schema.

`Liferay.Headless.Admin.User.everything.read`

List Unified Users`liferay_unified_list_users`

List Liferay user accounts mapped to the IAM unified user schema. Wraps GET /o/headless-admin-user/v1.0/user-accounts.

`Liferay.Headless.Admin.User.everything.read`

Get Unified User`liferay_unified_get_user`

Retrieve a single Liferay user account by id, mapped to the IAM unified user schema.

`Liferay.Headless.Admin.User.everything.read`

List Organizations`liferay_list_organizations`

Retrieve a paginated list of organizations from Liferay

`Liferay.Headless.Admin.User.everything.read`

Get Organization`liferay_get_organization`

Retrieve an organization by ID

`Liferay.Headless.Admin.User.everything.read`

Update Organization`liferay_patch_organization`

Update an existing organization

`Liferay.Headless.Admin.User.everything`

Create Organization`liferay_create_organization`

Create a new organization in Liferay

`Liferay.Headless.Admin.User.everything`

List Organization User Accounts`liferay_list_organization_user_accounts`

List users belonging to an organization

`Liferay.Headless.Admin.User.everything.read`

List Child Organizations`liferay_list_organization_child_organizations`

List child organizations under a parent organization

`Liferay.Headless.Admin.User.everything.read`

Delete Organization`liferay_delete_organization`

Delete an organization by ID

`Liferay.Headless.Admin.User.everything`

List Roles`liferay_list_roles`

Retrieve a paginated list of roles from Liferay

`Liferay.Headless.Admin.User.everything.read`

Get Role`liferay_get_role`

Retrieve a role by ID

`Liferay.Headless.Admin.User.everything.read`

Get Role By External Reference Code`liferay_get_role_by_external_reference_code`

Retrieve a role by its external reference code (ERC), a unique identifier string assigned when the role is synced from a...

`Liferay.Headless.Admin.User.everything.read`

Create Role`liferay_create_role`

Create a new role in Liferay

`Liferay.Headless.Admin.User.everything`

Update Role`liferay_patch_role`

Update an existing role

`Liferay.Headless.Admin.User.everything`

Delete Role`liferay_delete_role`

Delete a role by ID

`Liferay.Headless.Admin.User.everything`

Assign Role To User`liferay_assign_role_to_user`

Grant a role to a user account. Both IDs must be resolved from prior list/lookup calls — do not pass names, emails, or g...

`Liferay.Headless.Admin.User.everything`

Unassign Role From User`liferay_unassign_role_from_user`

Remove a role from a user account

`Liferay.Headless.Admin.User.everything`

Get Site`liferay_get_site`

Retrieve a site by ID

`Liferay.Headless.Admin.User.everything.read`

Get Site By Friendly URL Path`liferay_get_site_by_friendly_url_path`

Retrieve a site by its human-readable URL path

`Liferay.Headless.Admin.User.everything.read`

List Site User Accounts`liferay_list_site_user_accounts`

List users who are members of a specific site. Scope is restricted to users explicitly assigned to the given siteId — us...

`Liferay.Headless.Admin.User.everything.read`

List My Sites`liferay_list_my_sites`

Retrieve all sites the current user has access to. PREFERRED discovery tool when a site name or friendly URL is known bu...

`Liferay.Headless.Admin.User.everything.read`

List Structured Content Folders`liferay_list_structured_content_folders`

Retrieve a paginated list of structured content folders for a site

`Liferay.Headless.Delivery.everything.read`

Create Structured Content Folder`liferay_create_structured_content_folder`

Create a new folder for organizing structured content

`Liferay.Headless.Delivery.everything`

Get Structured Content Folder`liferay_get_structured_content_folder`

Retrieve a structured content folder by ID

`Liferay.Headless.Delivery.everything.read`

Update Structured Content Folder`liferay_patch_structured_content_folder`

Update an existing structured content folder

`Liferay.Headless.Delivery.everything`

List Structured Content Folder Subfolders`liferay_list_structured_content_folder_subfolders`

List subfolders of a structured content folder

`Liferay.Headless.Delivery.everything.read`

List Structured Content Folder Contents`liferay_list_structured_content_folder_contents`

List structured content articles inside a folder

`Liferay.Headless.Delivery.everything.read`

Delete Structured Content Folder`liferay_delete_structured_content_folder`

Delete a structured content folder by ID

`Liferay.Headless.Delivery.everything`

List Structured Contents`liferay_list_structured_contents`

Retrieve a paginated list of structured content (web content) for a site

`Liferay.Headless.Delivery.everything.read`

Create Structured Content`liferay_create_structured_content`

Create a new structured content article (web content) in a site

`Liferay.Headless.Delivery.everything`

Update Structured Content`liferay_patch_structured_content`

Partially update an existing structured content article (title, contentFields, description, keywords, friendlyUrlPath, e...

`Liferay.Headless.Delivery.everything`

Delete Structured Content`liferay_delete_structured_content`

Delete a structured content article by ID

`Liferay.Headless.Delivery.everything`

Get Structured Content`liferay_get_structured_content`

Retrieve a structured content article by ID

`Liferay.Headless.Delivery.everything.read`

List Site Taxonomy Vocabularies`liferay_list_site_taxonomy_vocabularies`

Retrieve taxonomy vocabularies defined in a site

`Liferay.Headless.Admin.Taxonomy.everything.read`

List Taxonomy Categories`liferay_list_taxonomy_categories`

List taxonomy categories under a taxonomy vocabulary

`Liferay.Headless.Admin.Taxonomy.everything.read`

List User Groups`liferay_list_user_groups`

Retrieve a paginated list of user groups from Liferay

`Liferay.Headless.Admin.User.everything.read`

Get User Group`liferay_get_user_group`

Retrieve a user group by ID

`Liferay.Headless.Admin.User.everything.read`

Update User Group`liferay_patch_user_group`

Update an existing user group

`Liferay.Headless.Admin.User.everything`

Create User Group`liferay_create_user_group`

Create a new user group in Liferay

`Liferay.Headless.Admin.User.everything`

List User Group Members`liferay_list_user_group_members`

List users belonging to a user group

`Liferay.Headless.Admin.User.everything.read`

Add Users To User Group`liferay_add_users_to_user_group`

Add users to a user group

`Liferay.Headless.Admin.User.everything`

Remove Users From User Group`liferay_remove_users_from_user_group`

Remove users from a user group

`Liferay.Headless.Admin.User.everything`

Delete User Group`liferay_delete_user_group`

Permanently delete a user group by ID. Returns 403 Forbidden for system-managed or otherwise non-deletable groups; treat...

`Liferay.Headless.Admin.User.everything`

List User Accounts`liferay_list_user_accounts`

Retrieve a paginated list of portal user accounts from Liferay with optional search/filter. NOT the preferred tool when...

`Liferay.Headless.Admin.User.everything.read`

Get User Account`liferay_get_user_account`

Retrieve a single user account by ID

`Liferay.Headless.Admin.User.everything.read`

Get User Account By Email Address`liferay_get_user_account_by_email_address`

PREFERRED tool for looking up a single user account by email address. Use this whenever the prompt provides an email and...

`Liferay.Headless.Admin.User.everything.read`

List User Accounts By Status`liferay_list_user_accounts_by_status`

List users filtered by status

`Liferay.Headless.Admin.User.everything.read`

List User Groups For User`liferay_list_user_groups_for_user`

List the user groups that a specific user belongs to. Requires a userAccountId — use list\_user\_accounts or get\_user\_acco...

`Liferay.Headless.Admin.User.everything.read`

Get My User Account`liferay_get_my_user_account`

Retrieve the currently authenticated user's account

`Liferay.Headless.Admin.User.everything.read`

Create User Account`liferay_create_user_account`

Create a new user account in Liferay. Returns 409 Conflict when a user with the same email or screenName already exists;...

`Liferay.Headless.Admin.User.everything`

Update User Account`liferay_patch_user_account`

Update an existing user account

`Liferay.Headless.Admin.User.everything`

Delete User Account`liferay_delete_user_account`

Delete a user account by ID

`Liferay.Headless.Admin.User.everything`

## Events

Tags

Select all
|
Clear

Accounts

Organizations

Users

Webhooks

No tags found

10 events

EventDescriptionTags

Active Check`liferay_active_check`

Responds with 200 OK to Liferay webhook deliveries that carry no recognizable event payload.

Webhooks

User Created`liferay_webhook_user_created`

Processes Liferay user created events, fired when a user account is added to the instance.

UsersWebhooks

User Updated`liferay_webhook_user_updated`

Processes Liferay user updated events, fired when a user account is modified.

UsersWebhooks

User Deleted`liferay_webhook_user_deleted`

Processes Liferay user deleted events, fired when a user account is removed from the instance.

UsersWebhooks

Account Created`liferay_webhook_account_created`

Processes Liferay account created events, fired when an account (business/person account) is added.

AccountsWebhooks

Account Updated`liferay_webhook_account_updated`

Processes Liferay account updated events, fired when an account is modified.

AccountsWebhooks

Account Deleted`liferay_webhook_account_deleted`

Processes Liferay account deleted events, fired when an account is removed.

AccountsWebhooks

Organization Created`liferay_webhook_organization_created`

Processes Liferay organization created events, fired when an organization is added.

OrganizationsWebhooks

Organization Updated`liferay_webhook_organization_updated`

Processes Liferay organization updated events, fired when an organization is modified.

OrganizationsWebhooks

Organization Deleted`liferay_webhook_organization_deleted`

Processes Liferay organization deleted events, fired when an organization is removed.

OrganizationsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.