Skip to content
Closed
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions api-reference/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Trophy keeps track of and displays when each API key in your account was created
<img height="200" noZoom src="../assets/api/authentication/api_keys.png" />
</Frame>

### Anatomy of an API key {#anatomy-of-an-api-key}
### Anatomy of an API Key {#anatomy-of-an-api-key}

Each API key is made up of 2 parts separated by a period:

Expand All @@ -44,7 +44,7 @@ curl https://app.trophy.so/api/users/<userId>/metrics/<key> \

If you do not pass an API key, or your API key is invalid, you'll receive a `401` response code.

## Managing API keys {#managing-api-keys}
## Managing API Keys {#managing-api-keys}

There are a few different operations you can perform on API keys from within your Trophy dashboard to manage your integration.

Expand All @@ -56,15 +56,15 @@ There are a few different operations you can perform on API keys from within you
/>
</Frame>

### Rotating keys {#rotating-keys}
### Rotating Keys {#rotating-keys}

API keys can be rotated if you want to change them for any reason. At the point of rotation, the original API key will no longer function and any requests still using it will begin receiving `401` responses immediately.

<Note>
Note that when rotating keys, both the prefix and the body will change.
</Note>

### Revoking keys {#revoking-keys}
### Revoking Keys {#revoking-keys}

API keys can also be revoked entirely at which point they become _Inactive_. At the point of revocation, the API key will no longer function and any requests still using it will begin receiving `401` responses immediately.

Expand All @@ -74,7 +74,7 @@ Once revoked you can re-activate the API key at any time.
Neither the prefix or the body of the key change when revoked or re-activated.
</Note>

### Deleting API keys {#deleting-api-keys}
### Deleting API Keys {#deleting-api-keys}

If you're 100% sure you no longer need an API key, they can be deleted.

Expand Down
Loading