Skip to content

Commit

Permalink
docs: improve findings of client secret and skippings of state verifi…
Browse files Browse the repository at this point in the history
…cation

Co-authored-by: Kazuhiro Sera <seratch@gmail.com>
  • Loading branch information
zimeg and seratch committed Aug 28, 2024
1 parent c06137f commit df109a1
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/content/basic/authenticating-oauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ The following `App` options are required for OAuth installations:

- `clientId`: `string`. An application credential found on the **Basic
Information** page of your [app settings][app-settings].
- `clientSecret`: `string`. A secret value to confirm the client ID.
- `clientSecret`: `string`. A secret value also found on the **Basic
Information** page of your [app settings][app-settings].
- `stateSecret`: `string`. A secret value used to
[generate and verify state][verification] parameters of authorization
requests.
Expand Down Expand Up @@ -78,8 +79,10 @@ We provide several options for customizing default OAuth using the
URL options. Optional.
- `redirectUriPath`: `string`. Path of the installation callback URL. Default:
`/slack/oauth_redirect`.
- `stateVerification`: `boolean`. Option to skip state verification for
requests. Default: `true`.
- `stateVerification`: `boolean`. Option to customize the state verification
logic. When set to `false`, the app does not verify the state parameter. While
not recommended for general OAuth security, some apps might want to skip this
for internal installations within an enterprise grid org. Default: `true`.
- `userScopes`: `string[]`. User scopes to request during installation. Default:
`[]`.
- `callbackOptions`: [`CallbackOptions`][callback-options]. Customized
Expand Down

0 comments on commit df109a1

Please sign in to comment.