Skip to content

Commit e20fb78

Browse files
committed
small corrections
1 parent a351dcf commit e20fb78

File tree

3 files changed

+4
-6
lines changed

3 files changed

+4
-6
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Unlike other keyrings that store user credentials, developer keyrings are design
44

55
## Snap-in secrets
66

7-
A `snap_in_secret` is a simple way to store any plain text secret your snap_in requires. It's ideal for sensitive information that doesn't require complex formatting.
7+
A snap-in secret is a simple way to store any plain text secret your snap_in requires. It's ideal for sensitive information that doesn't require complex formatting.
88

99
To create a snap-in secret in the UI, go to the snap-in page **Connection** tab and find the `snap_in_secret` keyring type.
1010

@@ -16,7 +16,7 @@ echo \"<SECRET>\" | devrev developer_keyring create snap-in-secret <KEYRING NAME
1616

1717
## OAuth secrets
1818

19-
An `oauth_secret` is specifically designed to store OAuth client credentials securely. It allows you to define two separate fields:
19+
The OAuth secret is specifically designed to store OAuth client credentials securely. It requires two fields:
2020

2121
* `client_id`: The client ID provided by the OAuth provider.
2222
* `client_secret`: The client secret provided by the OAuth provider.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Think of keyrings as secure vaults within your snap-in, acting as a middleman be
1717
## Supported credential types
1818

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

2222
## Access levels
2323

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ For comprehensive information about the OAuth specification, refer to the offici
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

15-
5. **Refreshing tokens:** A key benefit of using keyrings for OAuth is that they can handle refreshing access tokens automatically. Most OAuth implementations issue a refresh token alongside the access token. This refresh token can be used to obtain a new access token before the current one expires.
16-
- if refresh_token is not provided, the user will need to re-authorize the connection after the access token expires.
17-
- if refresh_token is expires, the user will need to re-authorize the connection after the access token expires.
15+
5. **Refreshing tokens:** A key benefit of using keyrings for OAuth is that they can handle refreshing access tokens automatically. Most OAuth implementations issue a refresh token alongside the access token. This refresh token can be used to obtain a new access token before the current one expires. If the token is not provided or is expired, the user will need to re-authorize the connection.
1816

1917
6. **Revoking tokens:** For enhanced security, you can also configure your keyring to revoke access tokens when they are no longer needed. This ensures that even if a token is compromised, it can't be used to access user data.
2018

0 commit comments

Comments
 (0)