Skip to content

Commit 51e22f7

Browse files
0x1LaraCroftDev
andauthored
Adding rotation guide for Flexport API keys (#28)
Co-authored-by: Nash <163340682+LaraCroftDev@users.noreply.github.com>
1 parent 7fe5c1b commit 51e22f7

File tree

11 files changed

+68
-9
lines changed

11 files changed

+68
-9
lines changed

content/docs/introduction/_table.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
[Airbrake](/docs/tutorials/airbrake)|[Atlassian](/docs/tutorials/atlassian)|[AWS](/docs/tutorials/aws)|
44
[Azure DevOps](/docs/tutorials/azuredevops)|[Azure Function](/docs/tutorials/azurefunctionkey)|[Azure Search Admin](/docs/tutorials/azuresearchadmin)|
55
[Azure Search Query](/docs/tutorials/azuresearchquery)|[Azure Storage](/docs/tutorials/azure)|[Eleven Labs](/docs/tutorials/elevenlabs)|
6-
[Eraser](/docs/tutorials/eraser)|[GCP](/docs/tutorials/gcp)|[GitHub](/docs/tutorials/github)|
7-
[GitLab](/docs/tutorials/gitlab)|[Groq](/docs/tutorials/groq)|[Mailchimp](/docs/tutorials/mailchimp)|
8-
[MaxMind](/docs/tutorials/maxmind)|[Microsoft Teams](/docs/tutorials/microsoftteams)|[MongoDB](/docs/tutorials/mongo)|
9-
[Netlify](/docs/tutorials/netlify)|[NPM](/docs/tutorials/npm)|[OpenAI](/docs/tutorials/openai)|
10-
[Sendbird](/docs/tutorials/sendbird)|[Sendgrid](/docs/tutorials/sendgrid)|[Slack](/docs/tutorials/slack)|
11-
[Slack Webhook](/docs/tutorials/slack-webhook)|[Sourcegraph](/docs/tutorials/sourcegraph)|[Square](/docs/tutorials/square)|
12-
[Stripe](/docs/tutorials/stripe)|[Sumo Logic](/docs/tutorials/sumologic)|[Tailscale](/docs/tutorials/tailscale)|
13-
[Twilio](/docs/tutorials/twilio)|
14-
[VTEX](/docs/tutorials/vtex)|
6+
[Eraser](/docs/tutorials/eraser)|[Flexport](/docs/tutorials/flexport)||
7+
[GCP](/docs/tutorials/gcp)|[GitHub](/docs/tutorials/github)|[GitLab](/docs/tutorials/gitlab)|
8+
[Groq](/docs/tutorials/groq)|[Mailchimp](/docs/tutorials/mailchimp)|[MaxMind](/docs/tutorials/maxmind)|
9+
[Microsoft Teams](/docs/tutorials/microsoftteams)|[MongoDB](/docs/tutorials/mongo)|[Netlify](/docs/tutorials/netlify)|
10+
[NPM](/docs/tutorials/npm)|[OpenAI](/docs/tutorials/openai)|[Sendbird](/docs/tutorials/sendbird)|
11+
[Sendgrid](/docs/tutorials/sendgrid)|[Slack](/docs/tutorials/slack)|[Slack Webhook](/docs/tutorials/slack-webhook)|
12+
[Sourcegraph](/docs/tutorials/sourcegraph)|[Square](/docs/tutorials/square)|[Stripe](/docs/tutorials/stripe)|
13+
[Sumo Logic](/docs/tutorials/sumologic)|[Tailscale](/docs/tutorials/tailscale)|[Twilio](/docs/tutorials/twilio)|
14+
[VTEX](/docs/tutorials/vtex)||

content/docs/tutorials/flexport.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Flexport
3+
---
4+
5+
_This tutorial provides step-by-step instructions on how to rotate a Flexport API key._
6+
7+
---
8+
9+
## Generate a new Flexport API key
10+
11+
### Step 1 - Navigate to the [Dashboard](https://portal.flexport.com/)
12+
13+
### Step 2 - Click on 'Settings' at the bottom of the left panel, or from the profile dropdown on the top right.
14+
![](/images/flexport/1.png)
15+
![](/images/flexport/2.png)
16+
17+
### 3. Navigate to the '[API Tokens](https://portal.flexport.com/settings/api-tokens)' tab.
18+
#### 3a. Click 'Generate API Token'
19+
![](/images/flexport/3.png)
20+
21+
22+
### 4. Select *only* the permissions that are necessary.
23+
#### 4a. Give it a descriptive name.
24+
#### 4b. Click 'Generate'.
25+
![](/images/flexport/4.png)
26+
27+
### 5. You can find your new key under the 'API Tokens' panel.
28+
#### 5a. Copy the key and store it in a password manager or secure vault.
29+
![](/images/flexport/5.png)
30+
> Note: You will notice that the status for your new key is set to `ACTIVE`.
31+
32+
---
33+
34+
## Revoking a Flexport API key
35+
36+
### Step 1 - Navigate to the [Dashboard](https://portal.flexport.com/)
37+
38+
### Step 2 - Click on 'Settings' at the bottom of the left panel, or from the profile dropdown on the top right.
39+
![](/images/flexport/1.png)
40+
![](/images/flexport/2.png)
41+
42+
### 3. Navigate to the '[API Tokens](https://portal.flexport.com/settings/api-tokens)' tab.
43+
#### 3a. Find the token you would like to rotate.
44+
#### 3b. Click the 'Edit' button.
45+
![](/images/flexport/6.png)
46+
47+
### 4. Click the 'Deactivate token' button.
48+
![](/images/flexport/7.png)
49+
50+
### 5. On the 'Deactivate token' modal, click the 'Yes, Deactivate Token' button.
51+
![](/images/flexport/8.png)
52+
53+
### 6. Go back to the 'API Tokens' tab, and ensure the token status is set to 'INACTIVE'.
54+
![](/images/flexport/9.png)
55+
56+
---
57+
58+
## Resources
59+
- [Flexport's Docs](https://developers.flexport.com/tutorials/using-api-credentials)
72.1 KB
Loading
89.9 KB
Loading
286 KB
Loading
847 KB
Loading
326 KB
Loading
326 KB
Loading
374 KB
Loading
375 KB
Loading
321 KB
Loading

0 commit comments

Comments
 (0)