Skip to content

Commit

Permalink
Adding rotation guide for Flexport API keys (#28)
Browse files Browse the repository at this point in the history
Co-authored-by: Nash <[email protected]>
  • Loading branch information
0x1 and LaraCroftDev authored Dec 9, 2024
1 parent 7fe5c1b commit 51e22f7
Show file tree
Hide file tree
Showing 11 changed files with 68 additions and 9 deletions.
18 changes: 9 additions & 9 deletions content/docs/introduction/_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
[Airbrake](/docs/tutorials/airbrake)|[Atlassian](/docs/tutorials/atlassian)|[AWS](/docs/tutorials/aws)|
[Azure DevOps](/docs/tutorials/azuredevops)|[Azure Function](/docs/tutorials/azurefunctionkey)|[Azure Search Admin](/docs/tutorials/azuresearchadmin)|
[Azure Search Query](/docs/tutorials/azuresearchquery)|[Azure Storage](/docs/tutorials/azure)|[Eleven Labs](/docs/tutorials/elevenlabs)|
[Eraser](/docs/tutorials/eraser)|[GCP](/docs/tutorials/gcp)|[GitHub](/docs/tutorials/github)|
[GitLab](/docs/tutorials/gitlab)|[Groq](/docs/tutorials/groq)|[Mailchimp](/docs/tutorials/mailchimp)|
[MaxMind](/docs/tutorials/maxmind)|[Microsoft Teams](/docs/tutorials/microsoftteams)|[MongoDB](/docs/tutorials/mongo)|
[Netlify](/docs/tutorials/netlify)|[NPM](/docs/tutorials/npm)|[OpenAI](/docs/tutorials/openai)|
[Sendbird](/docs/tutorials/sendbird)|[Sendgrid](/docs/tutorials/sendgrid)|[Slack](/docs/tutorials/slack)|
[Slack Webhook](/docs/tutorials/slack-webhook)|[Sourcegraph](/docs/tutorials/sourcegraph)|[Square](/docs/tutorials/square)|
[Stripe](/docs/tutorials/stripe)|[Sumo Logic](/docs/tutorials/sumologic)|[Tailscale](/docs/tutorials/tailscale)|
[Twilio](/docs/tutorials/twilio)|
[VTEX](/docs/tutorials/vtex)|
[Eraser](/docs/tutorials/eraser)|[Flexport](/docs/tutorials/flexport)||
[GCP](/docs/tutorials/gcp)|[GitHub](/docs/tutorials/github)|[GitLab](/docs/tutorials/gitlab)|
[Groq](/docs/tutorials/groq)|[Mailchimp](/docs/tutorials/mailchimp)|[MaxMind](/docs/tutorials/maxmind)|
[Microsoft Teams](/docs/tutorials/microsoftteams)|[MongoDB](/docs/tutorials/mongo)|[Netlify](/docs/tutorials/netlify)|
[NPM](/docs/tutorials/npm)|[OpenAI](/docs/tutorials/openai)|[Sendbird](/docs/tutorials/sendbird)|
[Sendgrid](/docs/tutorials/sendgrid)|[Slack](/docs/tutorials/slack)|[Slack Webhook](/docs/tutorials/slack-webhook)|
[Sourcegraph](/docs/tutorials/sourcegraph)|[Square](/docs/tutorials/square)|[Stripe](/docs/tutorials/stripe)|
[Sumo Logic](/docs/tutorials/sumologic)|[Tailscale](/docs/tutorials/tailscale)|[Twilio](/docs/tutorials/twilio)|
[VTEX](/docs/tutorials/vtex)||
59 changes: 59 additions & 0 deletions content/docs/tutorials/flexport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: Flexport
---

_This tutorial provides step-by-step instructions on how to rotate a Flexport API key._

---

## Generate a new Flexport API key

### Step 1 - Navigate to the [Dashboard](https://portal.flexport.com/)

### Step 2 - Click on 'Settings' at the bottom of the left panel, or from the profile dropdown on the top right.
![](/images/flexport/1.png)
![](/images/flexport/2.png)

### 3. Navigate to the '[API Tokens](https://portal.flexport.com/settings/api-tokens)' tab.
#### 3a. Click 'Generate API Token'
![](/images/flexport/3.png)


### 4. Select *only* the permissions that are necessary.
#### 4a. Give it a descriptive name.
#### 4b. Click 'Generate'.
![](/images/flexport/4.png)

### 5. You can find your new key under the 'API Tokens' panel.
#### 5a. Copy the key and store it in a password manager or secure vault.
![](/images/flexport/5.png)
> Note: You will notice that the status for your new key is set to `ACTIVE`.
---

## Revoking a Flexport API key

### Step 1 - Navigate to the [Dashboard](https://portal.flexport.com/)

### Step 2 - Click on 'Settings' at the bottom of the left panel, or from the profile dropdown on the top right.
![](/images/flexport/1.png)
![](/images/flexport/2.png)

### 3. Navigate to the '[API Tokens](https://portal.flexport.com/settings/api-tokens)' tab.
#### 3a. Find the token you would like to rotate.
#### 3b. Click the 'Edit' button.
![](/images/flexport/6.png)

### 4. Click the 'Deactivate token' button.
![](/images/flexport/7.png)

### 5. On the 'Deactivate token' modal, click the 'Yes, Deactivate Token' button.
![](/images/flexport/8.png)

### 6. Go back to the 'API Tokens' tab, and ensure the token status is set to 'INACTIVE'.
![](/images/flexport/9.png)

---

## Resources
- [Flexport's Docs](https://developers.flexport.com/tutorials/using-api-credentials)
Binary file added themes/compose/static/images/flexport/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/flexport/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/flexport/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/flexport/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/flexport/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/flexport/6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/flexport/7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/flexport/8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/flexport/9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 51e22f7

Please sign in to comment.