> For the complete documentation index, see [llms.txt](https://docs.uibakery.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.uibakery.io/on-premise/sso/openid/token-refresh.md).

# Token refresh

UI Bakery offers token refresh functionality for OpenID providers

When the OAuth token expires, UI Bakery will attempt to refresh it under the following conditions:

* The variable `UI_BAKERY_SSO_BROADCAST_TOKEN` must be set to `true`
* The `refresh_token` claim must be present
* The `expires_in` claim must also be present

You can control UI Bakery's token refresh logic using the following environment variables:

* **`UI_BAKERY_OAUTH_FORCE_TOKEN_REFRESH`**. If set to `true,` the SSO token will be refreshed with every UI Bakery token refresh. You can adjust the variable `UI_BAKERY_JWT_ACCESS_TOKEN_EXPIRATION` to control UI Bakery token lifetime.
* **`UI_BAKERY_OAUTH_SIGN_OUT_WHEN_TOKEN_EXPIRED`**. When set to `true`, if the user token cannot be refreshed, the user will be logged out from UI Bakery.
* **`UI_BAKERY_OAUTH_SYNC_ROLES_ON_TOKEN_REFRESH`**. If set to `true`, roles will be synchronized every SSO token refresh.

You can use the SSO token in [datasource requests](/on-premise/sso/openid.md#using-sso-token-in-data-source-requests).


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.uibakery.io/on-premise/sso/openid/token-refresh.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.