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.

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

feat: document ttl for api keys #1899

Merged
merged 8 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 16 additions & 4 deletions docs/concepts/personal-access-token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,14 @@ Follow these steps to create API Keys for your Project:

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.
5. Click **Create**
6. Copy the created API Key

Finding the best expiration date for an API token is always a tradeoff between security and usability. For maximum security use a
hperl marked this conversation as resolved.
Show resolved Hide resolved
short-lived API token, but consider that expiring API keys could lead to outages or other issues. For maximum usability use a
long-lived API token, but consider that it can be a security risk if the token leaks.

```mdx-code-block
<BrowserWindow url="https://console.ory.sh/projects/current/developers">
Expand Down Expand Up @@ -97,8 +103,14 @@ Follow these steps to create API keys for your workspace:
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.
7. Click **Create**
8. Copy the created API Key from the prompt that shows at the bottom right of the screen.

Finding the best expiration date for an API token is always a tradeoff between security and usability. For maximum security use a
short-lived API token, but consider that expiring API keys could lead to outages or other issues. For maximum usability use a
long-lived API token, but consider that it can be a security risk if the token leaks.

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