Repository navigation
docs: document managing and rotating personal api keys - #484
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Claude finished @mintlify[bot]'s task in 1m 0s —— View job Doc review: PR #484I checked every CLI command and flag the new prose uses (
|
| When `--api-token` is itself a personal API key, these limits apply: | ||
|
|
||
| - A key you create with it expires no later than that key, and is deleted along with it. | ||
| - You can only rotate or delete that key and the keys created with it. |
There was a problem hiding this comment.
Improvement: this list leaves out a rotation limit. kosli rotate api-key (client_reference/kosli_rotate_api-key.md:19-21) says that when you use a personal key as --api-token, the rotated key also expires no later than that key. A reader who rotates with --expires-at set a year out would expect the full lifetime and not get it. The --expires-at Warning in api_key_rotation.md:21 mentions only the 365-day cap, so it has the same gap. A second detail: kosli delete api-key (:21) says deleting any key also deletes the keys created with it, not only when the key is your current token.
| When `--api-token` is itself a personal API key, these limits apply: | |
| - A key you create with it expires no later than that key, and is deleted along with it. | |
| - You can only rotate or delete that key and the keys created with it. | |
| When `--api-token` is itself a personal API key, these limits apply: | |
| - A key you create or rotate with it expires no later than that key, and is deleted along with it. | |
| - You can only rotate or delete that key and the keys created with it. |
|
|
||
| To get a key that outlives the one you are using, create it from your **Profile** page. See [`kosli create api-key`](/client_reference/kosli_create_api-key), [`kosli rotate api-key`](/client_reference/kosli_rotate_api-key), [`kosli list api-keys`](/client_reference/kosli_list_api-keys), [`kosli get api-key`](/client_reference/kosli_get_api-key), and [`kosli delete api-key`](/client_reference/kosli_delete_api-key) for every flag. | ||
|
|
||
| Service accounts can't manage personal API keys. Use the service account key commands for them. |
There was a problem hiding this comment.
Suggestion: "them" can be read two ways: personal keys, or service accounts. I think the intended meaning is that --personal rejects a service account key as --api-token. Saying that directly avoids the confusion:
| Service accounts can't manage personal API keys. Use the service account key commands for them. | |
| `--personal` doesn't accept a service account API key as `--api-token`. To manage a service account's keys, use `--service-account` instead. |
Documents regenerating personal API keys in the app and managing them with
--personalin the CLI. This is GA: there's no flag, and it's in CLI v2.51.0 and live in prod per #changelog.Based on feat: manage personal API keys with
--personal, Add API endpoints for personal API keys and Add Regenerate for personal API keys.