Rename a User Personal Access Token

PATCH /user-pats/{name}

Rename User Pat

cURL

curl --request PATCH \
  --url https://api.example.com/user-pats/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_name": "<string>"
}
'

200

{
  "name": "<string>",
  "value": "<string>",
  "created_at": "<string>",
  "expires_at": "<string>"
}

Auth

Requires pats:create, not pats:delete — a rename leaves the token’s value intact, so it relabels the credential rather than revoking it. The rename applies to the caller’s own Logto personal access tokens, keyed on the token’s subject. No active organization is needed — user PATs aren’t org-bound.

Response

Same shape as one element of the List User Personal Access Tokens response, reflecting the new name.

Errors

Status	Cause
404 Not Found	No token with the given current name in Logto for this user.
409 Conflict	A token with new_name already exists for the caller.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

name · string · required

The PAT's current name, not an id — user PATs are addressed by name and have no local database row.

Body

application/json

new_name · string · required

New name for the token; must still be unique among the caller's user PATs (409 on collision).

Response

200

application/json

Successful Response

name · string · required

value · string · required

created_at · string | null

expires_at · string | null