Skip to content

Update api-key.mdx #307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SU-Cloudsmith wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update api-key.mdx #307

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions src/content/accounts-and-teams/api-key.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,37 @@ If you wish to restrict the use of your API-Key to a specific IP address or rang

One you have added your CIDR address/mask, just click the "+ Add" button to apply your restriction.

## Refreshing a Personal/User API Key
## Refreshing a Personal/User API Key from the webapp

If you lose the API key associated with your account, or suspect it has been compromised, you'll need to refresh the key, generating a new one.

To do this, under your profile menu, select Personal API Keys.
<BlockImage src={apiKeyImage} alt="Personal key menu item"></BlockImage>

Click the "Refresh API Key" button to generate a new API key.
<BlockImage src={refreshKeyImage} alt="Refreshing the key"></BlockImage>
<BlockImage src={refreshKeyImage} alt="Refreshing the key"></BlockImage>

## Refreshing a Personal/User API Key from the Cloudsmith CLI ##

This script uses SSO to login, grab the API key and workspace id. Just change the ORG_NAME to the your workspace id and you should be all set.

```
#!/bin/bash

ORG_NAME="cloudsmith"

# Step 1: Authenticate
cloudsmith auth -o $ORG_NAME

# List tokens for user and extract the slug_perm (grabbing the first for simplicity)
SLUG_PERM=$(cloudsmith tokens ls -F json | jq -r '.data[0].slug_perm')

# Now refresh the token to get a key valid for 2 hours, then export it for use
NEW_KEY=$(cloudsmith tokens refresh $SLUG_PERM -F json | grep '^{' | jq '.data.key')

echo "New API Key: $NEW_KEY"
export CLOUDSMITH_API_KEY=$NEW_KEY

# Step 4: Verify we're logged in
cloudsmith whoami
```