apikey

Update an API key

Update an API key by its ID. Requires a user authentication (not API key).

patch/apikey/{api_key_id}/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/apikey/{api_key_id}/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

api_key_idstring uuid required

Request body

Response

Successful Response

created_atstring date-time required
expire_atstring date-time nullable
idstring uuid required
key_prefixstring required

The first characters of the key's value, so it can be told apart from another in a list. The value itself is shown once, when the key is created, and is not recoverable afterwards.

last_used_atstring date-time nullable

When this key last authenticated a request, to the minute.

namestring required
org_idstring required
scope'read' | 'write' required

What a key may do.

Two values, not a permission matrix. The thing worth stopping is a write nobody watched: a leaked read key exposes what the dashboard already shows the holder, a leaked write key spends credits and sends mail. A free workspace may only mint READ.

updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.