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

Jump to bottom

feat: document ttl for api keys #1899

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: document ttl for api keys #1899

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Binary file modified docs/concepts/_static/api_keys/pak.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/concepts/_static/api_keys/wak.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 8 additions & 4 deletions docs/concepts/personal-access-token.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@

1. Go to <ConsoleLink route="project.developers" />.
2. Click **Create new API key**
3. Enter the API Key name and click **Create**
4. Copy the created API Key
3. Enter the API Key name
4. Select an **expiration** date. Note that it is not recommeded to create API keys without an expiry date.

Check warning on line 41 in docs/concepts/personal-access-token.mdx

View workflow job for this annotation

GitHub Actions / misspell

[misspell] docs/concepts/personal-access-token.mdx#L41 

"recommeded" is a misspelling of "recommended"
Raw output 
./docs/concepts/personal-access-token.mdx:41:54: "recommeded" is a misspelling of "recommended"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
4. Select an **expiration** date. Note that it is not recommeded to create API keys without an expiry date.
4. Select an **expiration** date. It is recommended to always create API keys with an expiry date.

Copy link
Contributor

Choose a reason for hiding this comment

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

I disagree with this recommendation. Expiring API keys are a recipe for outages 😆 . Also typo in recommended

5. Click **Create**
6. Copy the created API Key

```mdx-code-block
<BrowserWindow url="https://console.ory.sh/projects/current/developers">
Expand Down Expand Up @@ -97,8 +99,10 @@
2. Go to **Workspace settings** through the workspace menu in the top left corner.
3. Select **API keys** in the sidebar.
4. Click the **+** icon in the **API Keys** section.
5. Enter the API Key name and click **Create new API key**.
6. Copy the created API Key from the prompt that shows at the bottom right of the screen.
5. Enter the API Key name
6. Select an **expiration** date. Note that it is not recommeded to create API keys without an expiry date.

Check warning on line 103 in docs/concepts/personal-access-token.mdx

View workflow job for this annotation

GitHub Actions / misspell

[misspell] docs/concepts/personal-access-token.mdx#L103 

"recommeded" is a misspelling of "recommended"
Raw output 
./docs/concepts/personal-access-token.mdx:103:54: "recommeded" is a misspelling of "recommended"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
6. Select an **expiration** date. Note that it is not recommeded to create API keys without an expiry date.
6. Select an **expiration** date. It is recommended to always create API keys with an expiry date.

7. Click **Create**
8. Copy the created API Key from the prompt that shows at the bottom right of the screen.

```mdx-code-block
<BrowserWindow url="https://console.ory.sh/workspaces/current/settings/api-keys">
Expand Down
Loading