Skip to content

Commit ecc3000

Browse files
update
1 parent 962831e commit ecc3000

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

fern/docs/pages/references/keyrings/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Think of keyrings as secure vaults within your snap-in, acting as a middleman be
1616

1717
## Supported credential types
1818

19-
* **OAuth:** Streamline connections with popular services like Slack and Jira using pre-defined OAuth keyrings.
19+
* **OAuth 2.0 :** Streamline connections with popular services like Slack and Jira using pre-defined OAuth keyrings.
2020
* **Secrets:** Store various secret configurations, including personal access tokens (PATs) and multi-field tokens (JSON) for broader service integrations.
2121

2222
## Access levels

fern/docs/pages/references/keyrings/oauth_config.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ OAuth 2.0 (Open Authorization) is a widely adopted standard for authorization th
22

33
For comprehensive information about the OAuth specification, refer to the official documentation: [OAuth 2.0](https://oauth.net/2/).
44

5-
## Using OAuth keyrings
5+
## Using OAuth 2.0 keyrings
66

77
1. **Define the keyring:** Within your snap-in manifest, define a keyring specifically for OAuth credentials. DevRev offers pre-defined keyring types for popular services like Slack or Jira, simplifying the process.
88

99
2. **Provide credentials:** During development, you'll provide your developer keyring of type `oauth-secret` which contains client ID and client secret for the chosen service within the keyring definition. These credentials are securely stored and not distributed with your published snap-in.
1010

11-
3. **OAuth flow:** When your snap-in needs to access user data from the external service, it initiates the OAuth flow. This typically involves redirecting the user to the service's login page and then back to your snap-in after successful authorization.
11+
3. **OAuth 2.0 flow:** When your snap-in needs to access user data from the external service, it initiates the OAuth flow. This typically involves redirecting the user to the service's login page and then back to your snap-in after successful authorization.
1212

1313
4. **Access tokens:** Upon successful authorization, the service provides your snap-in with an access token. This token is used to access user data on the service's behalf without requiring the user's password again.
1414

fern/docs/pages/references/keyrings/secret_config.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ keyring_types:
114114
- id: <field_id_2>
115115
name: <field_name>
116116
description: <field_description>
117+
# The token_verification section is used to verify the token provided by the user.
117118
token_verification: # The token_verification section is used to verify the token provided by the user.
118119
url: <url> # The URL to which the token will be sent for verification.
119120
method: <method> # The HTTP method to be used for the verification request.

0 commit comments

Comments
 (0)