Skip to content
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

Add token rotation section to docs #1009

Merged
merged 4 commits into from
Jul 21, 2021
Merged

Add token rotation section to docs #1009

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bff1522
Add token rotation section to docs
misscoded Jul 19, 2021
10664ce
Specify support version
misscoded Jul 19, 2021
2559d8b
Add reference to needing OAuth package
misscoded Jul 20, 2021
efc3a26
Update docs/_advanced/token_rotation.md
misscoded Jul 20, 2021
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
2 changes: 1 addition & 1 deletion docs/_advanced/context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Adding context
lang: en
slug: context
order: 6
order: 7
---

<div class="section-content">
Expand Down
2 changes: 1 addition & 1 deletion docs/_advanced/conversation_store.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Conversation stores
lang: en
slug: conversation-store
order: 3
order: 4
---

<div class="section-content">
Expand Down
2 changes: 1 addition & 1 deletion docs/_advanced/custom_routes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Adding Custom HTTP routes
lang: en
slug: custom-routes
order: 9
order: 10
---

<div class="section-content">
Expand Down
2 changes: 1 addition & 1 deletion docs/_advanced/logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Logging
lang: en
slug: logging
order: 7
order: 8
---

<div class="section-content">
Expand Down
2 changes: 1 addition & 1 deletion docs/_advanced/middleware_global.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Global middleware
lang: en
slug: global-middleware
order: 4
order: 5
---

<div class="section-content">
Expand Down
2 changes: 1 addition & 1 deletion docs/_advanced/middleware_listener.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Listener middleware
lang: en
slug: listener-middleware
order: 5
order: 6
---

<div class="section-content">
Expand Down
2 changes: 1 addition & 1 deletion docs/_advanced/receiver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Customizing a receiver
lang: en
slug: receiver
order: 8
order: 9
---

<div class="section-content">
Expand Down
16 changes: 16 additions & 0 deletions docs/_advanced/token_rotation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Token rotation
lang: en
slug: token-rotation
order: 3
---

<div class="section-content">
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 token rotation automatically once enabled in your app's configuration.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As one of the prerequisites on the Bolt app side, we can mention the necessity to use @slack/oauth package's default authorize function along with InstallationStore. This sounds obvious to us but it's not the same particularly for the developers who are new to Bolt.

Also, we may want to update the OAuth package's document as well.


For more information about token rotation, please see the [documentation](https://api.slack.com/authentication/rotation).
</div>