> For the complete documentation index, see [llms.txt](https://indigo-dc.gitbook.io/liferay-iam-connector/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://indigo-dc.gitbook.io/liferay-iam-connector/service_reference.md).

# Service Reference Card

**Functional description:** Integrate OpenId Connect based authentication and authorisation in [Liferay 7.0 service](http://www.liferay.com). The token has to be compliant with the specifications defined in INDIGO-Datacloud project and implemented in the IAM service. Allow the validation and distribution of token to other service (e.g. the FutureGateway API service)

**Services running:**

* tomcat8: (Java application) needed to run Liferay

**Configuration:**

* The module introduce a new panel in Liferay Configuration. This allow to provide the information for the OpenId provider. The more important are:
  * *User credentials:* `id` and `secret` provided during the registration of the service in the provider
  * *Well known OpenId Connect configuration:* as an example for iam-test instace it is `https://iam-test.indigo-datacloud.eu/.well-known/openid-configuration`
* Registration in IAM:
  * *Return url:* `http(s)://<your_domain_name>/c/portal/iam_openidconnect`

**Logfile locations (and management) and other useful audit information:**

* *Liferay log:* LiferayIAM will log in the Liferay log files. As default they are in the log folder of tomcat and in a log folder outside of the `CATALINA_HOME`

**Open ports:**

* Liferay Server:
  * 80 and 443

**Where is service state held (and can it be rebuilt):** Configuration information are managed by Liferay which is responsible to keep the values across restart and/or during update of the module

**Cron jobs:** None

**Security information**

* Secure the token: the token should never be sent in un-secure connection so all the Liferay page involved with the authentication should be accessed with `https`, including the the communication involving the OpenId Connect provider
* User can be managed using the Liferay control panel

**Location of reference documentation:** [LiferayIAM on Gitbook](https://www.gitbook.com/book/indigo-dc/liferay-iam-connector/details)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://indigo-dc.gitbook.io/liferay-iam-connector/service_reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.