|
2 | 2 | title: VTEX |
3 | 3 | --- |
4 | 4 |
|
5 | | -*This tutorial provides step-by-step instructions on how to rotate a VTEX Application Key.* |
| 5 | +*This tutorial provides step-by-step instructions on how to rotate a VTEX API Key.* |
6 | 6 |
|
7 | 7 | --- |
8 | 8 |
|
9 | | -## Generate a new VTEX Application Key |
| 9 | +## Generate a new VTEX API Key |
10 | 10 |
|
11 | | -### Step 1 - Navigate to the Application Key page |
12 | | -Log into your VTEX admin account and navigate to `https://{accountName}.myvtex.com/admin/appkeys`. |
| 11 | +### Step 1 - Navigate to the API Keys page |
| 12 | +Log into your VTEX admin account and navigate to `https://{accountName}.myvtex.com/admin/api-keys`. |
13 | 13 |  |
14 | 14 |
|
15 | | -### Step 2 - Generate a new Application Key |
16 | | -#### 2a. Click `Manage My Keys` |
| 15 | +### Step 2 - Generate a new API Key |
| 16 | +#### 2a. Click `Generate Key` |
17 | 17 |  |
18 | | -#### 2b. Click `Generate New` |
19 | | - |
20 | | -#### 2c. Provide a `Label`, add roles and click `Generate` |
21 | | - |
22 | | -#### 2d. Copy the application token |
23 | | - |
| 18 | +#### 2b. Provide `Key identification`, add roles and click `Generate` |
| 19 | + |
| 20 | +#### 2c. Copy the token unique access link |
| 21 | + |
| 22 | +#### 2d. Navigate to the token unique access link |
| 23 | +Go to the link generated in the previous step, in the format `https://share.vtex.com/credentials/{token}`, where `token` is a random identifier generated when the key is created. |
| 24 | +#### 2e. Copy the `Key` and the `New token` and store it somewhere safe |
24 | 25 |
|
25 | 26 | --- |
26 | 27 |
|
27 | | -## Replace the Leaked VTEX Application Key |
28 | | -Replace the leaked VTEX Application Key with the new one in all impacted applications and services. |
| 28 | +## Replace the Leaked VTEX API Key |
| 29 | +Replace the leaked VTEX API Key with the new one in all impacted applications and services. |
29 | 30 |
|
30 | 31 | --- |
31 | 32 |
|
32 | | -## Revoke the Leaked VTEX Application Key |
| 33 | +## Revoke the Leaked VTEX API Key |
33 | 34 |
|
34 | | -### Step 1 - Navigate to the Application Key page |
35 | | -Log into your VTEX admin account and navigate to `https://{accountName}.myvtex.com/admin/appkeys`. |
| 35 | +### Step 1 - Navigate to the API Keys page |
| 36 | +Log into your VTEX admin account and navigate to `https://{accountName}.myvtex.com/admin/api-keys`. |
36 | 37 |  |
37 | 38 |
|
38 | | -### Step 2 - Revoke the VTEX Application Key |
39 | | -#### 2a. Click `Manage My Keys` |
40 | | - |
41 | | -#### 2b. Click `Deactivate` |
42 | | -Click the `Deactivate` menu option in the row corresponding to the Application Key you want to deactivate. |
| 39 | +### Step 2 - Revoke the VTEX API Key |
| 40 | +#### 2a. Click `Delete Key` |
| 41 | +Find the row of the API Key you want to delete and click the ellipsis menu `⋮`, then click the `Delete Key` menu option. |
| 42 | + |
| 43 | +#### 2b. Confirm deletion |
| 44 | +Check `I understand that this action cannot be undone` and click `Delete` to confirm. |
43 | 45 |  |
44 | 46 |
|
45 | 47 | --- |
46 | 48 |
|
47 | 49 | ## Resources |
48 | | -- [VTEX Application Key Documentation](https://help.vtex.com/en/tutorial/application-keys--2iffYzlvvz4BDMr6WGUtet) |
49 | | -- [VTEX Application Key Best Practices](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) |
| 50 | +- [VTEX API Key Documentation](https://help.vtex.com/en/tutorial/api-keys--4bFEmcHXgpNksoePchZyy6) |
| 51 | +- [VTEX API Key Best Practices](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) |
0 commit comments