200 OK
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
object |
UpdateApiKeyObject | ✔️ | N/A | |
id |
String | ✔️ | N/A | ak_3beecc9c60adb5f9b850e91a8ee1e992 |
type |
String | ✔️ | N/A | api_key |
subject |
String | ✔️ | N/A | user_2xhFjEI5X2qWRvtV13BzSj8H6Dk |
name |
String | ✔️ | N/A | MY_SERVICE_API_KEY |
description |
JsonNullable<String> | ➖ | N/A | This is my API Key |
claims |
Optional<Object> | ✔️ | N/A | { "foo": "bar" } |
scopes |
List<String> | ✔️ | N/A | [ "read", "write" ] |
revoked |
boolean | ✔️ | N/A | false |
revocationReason |
Optional<String> | ✔️ | N/A | Revoked by user |
expired |
boolean | ✔️ | N/A | false |
expiration |
Optional<Double> | ✔️ | The timestamp for when the API key will expire, in milliseconds | 1716883200 |
createdBy |
Optional<String> | ✔️ | N/A | user_2xhFjEI5X2qWRvtV13BzSj8H6Dk |
lastUsedAt |
Optional<Double> | ✔️ | The timestamp for when the API key was last used, in milliseconds | 1716883200 |
createdAt |
double | ✔️ | The timestamp for when the API key was created, in milliseconds | 1716883200 |
updatedAt |
double | ✔️ | The timestamp for when the API key was last updated, in milliseconds | 1716883200 |