From bff1522086c69b0c217e7dbe6c0aeb0db66cef87 Mon Sep 17 00:00:00 2001 From: Alissa Renz Date: Mon, 19 Jul 2021 09:16:57 -0700 Subject: [PATCH 1/4] Add token rotation section to docs --- docs/_advanced/context.md | 2 +- docs/_advanced/conversation_store.md | 2 +- docs/_advanced/custom_routes.md | 2 +- docs/_advanced/logging.md | 2 +- docs/_advanced/middleware_global.md | 2 +- docs/_advanced/middleware_listener.md | 2 +- docs/_advanced/receiver.md | 2 +- docs/_advanced/token_rotation.md | 16 ++++++++++++++++ 8 files changed, 23 insertions(+), 7 deletions(-) create mode 100644 docs/_advanced/token_rotation.md diff --git a/docs/_advanced/context.md b/docs/_advanced/context.md index 0decd3817..1307428fa 100644 --- a/docs/_advanced/context.md +++ b/docs/_advanced/context.md @@ -2,7 +2,7 @@ title: Adding context lang: en slug: context -order: 6 +order: 7 ---
diff --git a/docs/_advanced/conversation_store.md b/docs/_advanced/conversation_store.md index 147d0e21e..2232014f3 100644 --- a/docs/_advanced/conversation_store.md +++ b/docs/_advanced/conversation_store.md @@ -2,7 +2,7 @@ title: Conversation stores lang: en slug: conversation-store -order: 3 +order: 4 ---
diff --git a/docs/_advanced/custom_routes.md b/docs/_advanced/custom_routes.md index 48017f05f..2426c0d3a 100644 --- a/docs/_advanced/custom_routes.md +++ b/docs/_advanced/custom_routes.md @@ -2,7 +2,7 @@ title: Adding Custom HTTP routes lang: en slug: custom-routes -order: 9 +order: 10 ---
diff --git a/docs/_advanced/logging.md b/docs/_advanced/logging.md index 84204e293..2352ced9b 100644 --- a/docs/_advanced/logging.md +++ b/docs/_advanced/logging.md @@ -2,7 +2,7 @@ title: Logging lang: en slug: logging -order: 7 +order: 8 ---
diff --git a/docs/_advanced/middleware_global.md b/docs/_advanced/middleware_global.md index fa490a30c..2f16319fa 100644 --- a/docs/_advanced/middleware_global.md +++ b/docs/_advanced/middleware_global.md @@ -2,7 +2,7 @@ title: Global middleware lang: en slug: global-middleware -order: 4 +order: 5 ---
diff --git a/docs/_advanced/middleware_listener.md b/docs/_advanced/middleware_listener.md index 2f445d311..8022e61c1 100644 --- a/docs/_advanced/middleware_listener.md +++ b/docs/_advanced/middleware_listener.md @@ -2,7 +2,7 @@ title: Listener middleware lang: en slug: listener-middleware -order: 5 +order: 6 ---
diff --git a/docs/_advanced/receiver.md b/docs/_advanced/receiver.md index 61008a33f..1535ea28a 100644 --- a/docs/_advanced/receiver.md +++ b/docs/_advanced/receiver.md @@ -2,7 +2,7 @@ title: Customizing a receiver lang: en slug: receiver -order: 8 +order: 9 ---
diff --git a/docs/_advanced/token_rotation.md b/docs/_advanced/token_rotation.md new file mode 100644 index 000000000..9d823768c --- /dev/null +++ b/docs/_advanced/token_rotation.md @@ -0,0 +1,16 @@ +--- +title: Token rotation +lang: en +slug: token-rotation +order: 3 +--- + +
+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. + +For more information about token rotation, please see the [documentation](https://api.slack.com/authentication/rotation). +
From 10664cef75a74405a35494c65ed0155b6c3723b6 Mon Sep 17 00:00:00 2001 From: Alissa Renz Date: Mon, 19 Jul 2021 15:04:44 -0700 Subject: [PATCH 2/4] Specify support version --- docs/_advanced/token_rotation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_advanced/token_rotation.md b/docs/_advanced/token_rotation.md index 9d823768c..dde7c24ce 100644 --- a/docs/_advanced/token_rotation.md +++ b/docs/_advanced/token_rotation.md @@ -6,7 +6,7 @@ order: 3 ---
-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. From 2559d8b28036a126a09dea139babc53f502d110b Mon Sep 17 00:00:00 2001 From: Alissa Renz Date: Tue, 20 Jul 2021 15:29:04 -0700 Subject: [PATCH 3/4] Add reference to needing OAuth package --- docs/_advanced/token_rotation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_advanced/token_rotation.md b/docs/_advanced/token_rotation.md index dde7c24ce..4ddf37359 100644 --- a/docs/_advanced/token_rotation.md +++ b/docs/_advanced/token_rotation.md @@ -10,7 +10,7 @@ Supported in Bolt for JavaScript as of v3.5.0, token rotation provides an extra 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. +Bolt for JavaScript supports and will handle token rotation automatically so long as the [built-in OAuth](https://slack.dev/node-slack-sdk/oauth) functionality is used. For more information about token rotation, please see the [documentation](https://api.slack.com/authentication/rotation).
From efc3a26f81c13e2dab17b475af70feb0e1498c80 Mon Sep 17 00:00:00 2001 From: Alissa Renz Date: Tue, 20 Jul 2021 15:49:06 -0700 Subject: [PATCH 4/4] Update docs/_advanced/token_rotation.md Co-authored-by: Steve Gill --- docs/_advanced/token_rotation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_advanced/token_rotation.md b/docs/_advanced/token_rotation.md index 4ddf37359..da17d1e11 100644 --- a/docs/_advanced/token_rotation.md +++ b/docs/_advanced/token_rotation.md @@ -10,7 +10,7 @@ Supported in Bolt for JavaScript as of v3.5.0, token rotation provides an extra 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](https://slack.dev/node-slack-sdk/oauth) functionality is used. +Bolt for JavaScript supports and will handle token rotation automatically so long as the [built-in OAuth](https://slack.dev/bolt-js/concepts#authenticating-oauth) functionality is used. For more information about token rotation, please see the [documentation](https://api.slack.com/authentication/rotation).