419eba5fb6
Closes #13434 Supersedes #14182 --------- Co-authored-by: Ethan <39577870+ethanndickson@users.noreply.github.com> Co-authored-by: Ethan Dickson <ethan@coder.com> Co-authored-by: Ben Potter <ben@coder.com> Co-authored-by: Stephen Kirby <58410745+stirby@users.noreply.github.com> Co-authored-by: Stephen Kirby <me@skirby.dev> Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
1.9 KiB
API & Session Tokens
Users can generate tokens to make API requests on behalf of themselves.
Short-Lived Tokens (Sessions)
The Coder CLI and Backstage Plugin use
short-lived token to authenticate. To generate a short-lived session token on
behalf of your account, visit the following URL:
https://coder.example.com/cli-auth
Session Durations
By default, sessions last 24 hours and are automatically refreshed. You can
configure
CODER_SESSION_DURATION to
change the duration and
CODER_DISABLE_SESSION_EXPIRY_REFRESH
to configure this behavior.
Long-Lived Tokens (API Tokens)
Users can create long lived tokens. We refer to these as "API tokens" in the product.
Generate a long-lived API token on behalf of yourself
UI
Visit your account settings in the top right of the dashboard or by navigating
to https://coder.example.com/settings/account
Navigate to the tokens page in the sidebar and create a new token:
CLI
Use the following command:
coder tokens create --name=my-token --lifetime=720h
See the help docs for
coder tokens create for more info.
Generate a long-lived API token on behalf of another user
Today, you must use the REST API to generate a token on behalf of another user.
You must have the Owner role to do this. Use our API reference for more
information:
Create token API key
Set max token length
You can use the
CODER_MAX_TOKEN_LIFETIME
server flag to set the maximum duration for long-lived tokens in your
deployment.