You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 7, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: content/en/getting-started/auth-token/index.md
+60-36Lines changed: 60 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,24 +2,29 @@
2
2
title: "Auth Token"
3
3
weight: 20
4
4
description: >
5
-
Configure your Auth Token to start LocalStack
5
+
Configure your Auth Token to access and activate LocalStack.
6
6
---
7
7
8
8
## Introduction
9
9
10
-
The Auth Token is a personal identifier used for user authentication outside the LocalStack Web Application, particularly in conjunction with the LocalStack core cloud emulator.
11
-
Its primary functions are to retrieve the user's license and enable access to advanced features, effectively replacing the older developer API keys.
10
+
The Auth Token identifies and authenticates users outside the LocalStack Web Application to activate the LocalStack core cloud emulator.
11
+
It primarily accesses your workspace and advanced services & features.
12
12
13
-
The Auth Token remains unchanged unless manually rotated by the user, regardless of any license assignment changes.
14
-
You can locate your Auth Token on the [Getting Started page](https://app.localstack.cloud/getting-started) or the [Auth Token page](https://app.localstack.cloud/workspace/auth-token) in the LocalStack Web Application.
13
+
Auth tokens come in two types: a **Developer Auth Token** and a **CI Auth Token**:
15
14
16
-
{{< callout "warning" >}}
17
-
- Previously, API keys were required to activate the LocalStack core cloud emulator.
18
-
These API keys are now being replaced by Auth Tokens.
19
-
- Currently, LocalStack supports both API Keys and Auth Tokens.
20
-
However, API Keys will be discontinued in the upcoming major release of LocalStack.
21
-
- To update your LocalStack configuration, replace your API Key with an Auth Token.
22
-
Use the `LOCALSTACK_AUTH_TOKEN` environment variable in place of `LOCALSTACK_API_KEY`.
15
+
- The **Developer Auth Token** is linked to a specific user within a specific workspace.
16
+
Every user has their own Auth Token.
17
+
It cannot be deleted but can be rotated for security reasons if needed.
18
+
- The **CI Auth Token** is not associated with any specific user and is designed for use in CI environments and other non-developer contexts.
19
+
These tokens are stored in the workspace and can be managed by members with appropriate permissions.
20
+
21
+
Both the **Developer Auth Token** and **CI Auth Token** can be managed on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens).
22
+
23
+
{{< callout "warning">}}
24
+
- It's crucial to keep your Auth Token confidential.
25
+
Do not include it in source code management systems, such as Git repositories.
26
+
- Be aware that if an Auth Token is committed to a public repository, it is at risk of exposure, and could remain in the repository's history, even if attempts are made to rewrite it.
27
+
- In case your Auth Token is accidentally published, immediately rotate it on the [Auth Token page](https://app.localstack.cloud/workspace/auth-tokens).
23
28
{{< /callout >}}
24
29
25
30
## Managing your License
@@ -51,7 +56,7 @@ If you do not assign a license, you will not be able to use LocalStack even if y
51
56
{{< /callout >}}
52
57
53
58
To view your own assigned license, visit the [My License page](https://app.localstack.cloud/workspace/my-license).
54
-
You can further navigate to the [Auth Token page](https://app.localstack.cloud/workspace/auth-token) to view your Auth Token.
59
+
You can further navigate to the [Auth Token page](https://app.localstack.cloud/workspace/auth-tokens) to view your **Developer Auth Token** and **CI Auth Token**.
55
60
56
61
## Configuring your Auth Token
57
62
@@ -63,7 +68,7 @@ The following sections describe the various methods of setting your Auth Token.
63
68
- It's crucial to keep your Auth Token confidential.
64
69
Do not include it in source code management systems, such as Git repositories.
65
70
- Be aware that if an Auth Token is committed to a public repository, it's at risk of exposure, and could remain in the repository's history, even if attempts are made to rewrite it.
66
-
- In case your Auth Token is accidentally published, immediately rotate it on the [Auth Token page](https://app.localstack.cloud/workspace/auth-token).
71
+
- In case your Auth Token is accidentally published, immediately rotate it on the [Auth Token page](https://app.localstack.cloud/workspace/auth-tokens).
You can manually set the Auth Token, or use the `export` command to establish the Auth Token in your current shell session.
122
128
This ensures the Auth Token is transmitted to your LocalStack container, enabling key activation.
123
129
124
-
## Licensing-related configuration
130
+
### CI Environments
131
+
132
+
CI environments require a CI Auth Token.
133
+
Developer Auth Tokens cannot be used in CI.
134
+
CI Auth Tokens are available on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) and are configured similarly to Developer Auth Tokens.
135
+
136
+
To set the CI Auth Token, add the Auth Token value in the `LOCALSTACK_AUTH_TOKEN` environment variable of your CI provider, and refer to it when starting LocalStack in your CI workflow.
137
+
You can find detailed examples in our [LocalStack in CI documentation](https://docs.localstack.cloud/user-guide/ci/).
138
+
139
+
## Rotating the Auth Token
140
+
141
+
Your personal Auth Token provides full access to your workspace and LocalStack license.
142
+
It's important to treat auth tokens as confidential, avoiding sharing or storing them in source control management systems (SCMs) like Git.
143
+
144
+
If you believe your Auth Token has been compromised or becomes known to someone else, reset it without delay.
145
+
When you reset a token, the old one is immediately deactivated, losing its ability to access your license or workspace.
146
+
It is not possible to restore previous tokens.
147
+
148
+
To rotate your Auth Token, go to the [Auth Token page](https://app.localstack.cloud/workspace/auth-tokens) and select the **Reset Auth Token** option.
149
+
150
+
## Licensing configuration & activation checkup
125
151
126
152
To avoid logging any licensing-related error messages, set `LOG_LICENSE_ISSUES=0` in your environment.
127
153
Refer to our [configuration guide](https://docs.localstack.cloud/references/configuration/#localstack-pro) for more information.
128
154
129
-
## Checking license activation
130
-
131
155
The simplest method to verify if LocalStack is active is by querying the health endpoint for a list of running services:
132
156
133
157
{{< tabpane text=true >}}
@@ -170,37 +194,37 @@ Another way to confirm this is by checking the logs of the LocalStack container
170
194
[...] Successfully activated license
171
195
{{< / command >}}
172
196
173
-
Otherwise, check our collected most [common activation issues](#common-activation-issues).
Your personal Auth Token provides full access to your workspace and LocalStack license.
178
-
It's important to treat auth tokens as confidential, avoiding sharing or storing them in source control management systems (SCMs) like Git.
201
+
### How do I activate older versions of LocalStack (Before v3.0)?
179
202
180
-
If you believe your Auth Token has been compromised or becomes known to someone else, reset it without delay.
181
-
When you reset a token, the old one is immediately deactivated, losing its ability to access your license or workspace.
182
-
It is not possible to restore previous tokens.
203
+
Prior to the introduction of Auth Tokens, LocalStack used **API keys** managed through the `LOCALSTACK_API_KEY` environment variable for activation.
204
+
205
+
For backwards compatibility, we've updated our back-end to accept new Auth Tokens within the `LOCALSTACK_API_KEY` variable.
206
+
You can use the new Auth Token in the same way you previously used the API key.
183
207
184
-
To rotate your Auth Token, go to the [Auth Token page](https://app.localstack.cloud/workspace/auth-token) and select the **Reset Auth Token** option.
208
+
### When will the legacy API keys be phased out?
185
209
186
-
### Configuring your CI environment
210
+
In early 2025, we will begin phasing out legacy API keys entirely.
211
+
After the sunsetting period, legacy API and legacy CI keys will no longer activate or work with LocalStack.
187
212
188
-
For use in Continuous Integration (CI) or automated test environments, a CI key is necessary.
189
-
Refer to our [CI documentation]({{< ref "user-guide/ci" >}}) for guidance on securely handling secrets, including storing your CI key in these environments.
213
+
During the sunsetting period, the legacy service will experience scheduled downtimes.
214
+
These are planned to encourage users to transition to new Auth Tokens while minimizing impact for those who have not yet updated.
190
215
191
-
To configure your CI key, you need to set the `LOCALSTACK_API_KEY` environment variable to your CI key.
192
-
You can find your CI key on the [CI Keys page](https://app.localstack.cloud/workspace/ci-keys) in the LocalStack Web Application.
216
+
The downtime schedule will be communicated well in advance, allowing users ample time to switch to the new Auth Tokens.
193
217
194
-
## Common activation issues
218
+
## Troubleshooting
195
219
196
-
Starting from version 2.0.0, the `localstack/localstack-pro` image in LocalStack demands a successful license activation for startup.
220
+
While using Auth Tokens, LocalStack demands a successful license activation for startup.
197
221
If the activation of the license is unsuccessful, LocalStack will exit and display error messages.
198
222
199
223
```bash
200
224
===============================================
201
225
License activation failed! 🔑❌
202
226
203
-
Reason: The credentials defined in your environment are invalid. Please make sure to either set the LOCALSTACK_AUTH_TOKEN variable to a valid auth token, or the LOCALSTACK_API_KEY variable to a valid LocalStack API key. You can find your auth token or API key in the LocalStack web app https://app.localstack.cloud.
227
+
Reason: The credentials defined in your environment are invalid. Please make sure to either set the LOCALSTACK_AUTH_TOKEN variable to a valid auth token, or the LOCALSTACK_API_KEY variable to a valid LocalStack API key. You can find your Auth Token or API key in the LocalStack web app https://app.localstack.cloud.
204
228
205
229
Due to this error, Localstack has quit. LocalStack pro features can only be used with a valid license.
206
230
@@ -213,8 +237,8 @@ The key activation in LocalStack may fail for several reasons, and the most comm
213
237
214
238
### Missing Credentials
215
239
216
-
You need to provide either an Auth Token or an API Key to start the LocalStack Pro image successfully.
217
-
You can find your Auth Token or API Key on the [Auth Token page](https://app.localstack.cloud/workspace/auth-token) or the [Legacy API Key page](https://app.localstack.cloud/workspace/api-keys) in the LocalStack Web Application.
240
+
You need to provide either an Auth Token to start the LocalStack Pro image successfully.
241
+
You can find your Auth Token on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) in the LocalStack Web Application.
218
242
219
243
If you are using the `localstack` CLI, you can set the `LOCALSTACK_AUTH_TOKEN` environment variable to your Auth Token or use the following command to set it up:
0 commit comments