8000 docs: rotate tokens on a separate schedule with the oauth package by zimeg · Pull Request #2558 · slackapi/bolt-js · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: rotate tokens on a separate schedule with the oauth package #2558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 9, 2025
Merged

docs: rotate tokens on a separate schedule with the oauth package #2558

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
184767a
docs: rotate tokens on a separate schedule with the oauth package
zimeg May 30, 2025
3096287
chore: merge w main
zimeg Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions docs/content/concepts/token-rotation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,33 @@ lang: en
slug: /concepts/token-rotation
---

Supported in Bolt for JavaScript as of v3.5.0, token rotation provides an extra layer of security for your access tokens and is defined by the [OAuth V2 RFC](https://datatracker.ietf.org/doc/html/rfc6749#section-10.4).
Supported in Bolt for JavaScript as of v3.5.0, token rotation provides an extra layer of security for your access tokens and is defined by the [OAuth V2 RFC](https://datatracker.ietf.org/doc/html/rfc6749#section-10.4).

Instead of an access token representing an existing installation of your Slack app indefinitely, with token rotation enabled, access tokens expire. A refresh token acts as a long-lived way to refresh your access tokens.

Bolt for JavaScript supports and will handle token rotation automatically so long as the [built-in OAuth](/concepts/authenticating-oauth) functionality is used.
Bolt for JavaScript will rotate tokens automatically in response to incoming events so long as the [built-in OAuth](/concepts/authenticating-oauth) functionality is used.

For more information about token rotation, please see the [documentation](https://docs.slack.dev/authentication/using-token-rotation).
To rotate tokens on a separate schedule, consider implementing the `InstallProvider` from the [`@slack/oauth`](https://tools.slack.dev/node-slack-sdk/oauth) package for use of the provided `authorize` method:

```js
const { InstallProvider } = require("@slack/oauth");

const installer = new InstallProvider({
clientId: process.env.SLACK_CLIENT_ID,
clientSecret: process.env.SLACK_CLIENT_SECRET,
stateSecret: process.env.SLACK_STATE_SECRET,
});

async function rotateTokenBeforeUsing(query) {
return await installer.authorize({
enterpriseId: query.enterpriseId,
teamId: query.teamId,
// User tokens can also be rotated if needed
// userId: query.userId,
});
}
```

The above implementation also requires an installation [store](https://tools.slack.dev/node-slack-sdk/oauth/#storing-installations-in-a-database) to fetch and store installation information according to the incoming installation query.

For more information about token rotation, please see the [documentation](https://docs.slack.dev/authentication/using-token-rotation).
0