跳转到主要内容
POST
POST /admin/api/api-keys/{id}/rotate

授权

gproxy_session
string
cookie
必填

请求头

x-gproxy-admin-scope
string

Administrative scope selected by the caller.

路径参数

id
string
必填

响应

Success

A minted or rotated key. token is the only time the plaintext exists in a response; a caller that loses it rotates the key, it is not recoverable unless the row was created with retainSecret.

enabled
boolean
必填
expiresAtMs
integer<int64> | null
必填
hasSecret
boolean
必填

Whether the instance retained a sealed copy of the key text, i.e. whether reveal can answer. The bytes themselves have no field.

id
string
必填
kind
string
必填

user or oauth. An oauth key is a grant's internal key and is not a bearer credential; it is listed so an operator can see it, never created or revealed through this family.

management
boolean
必填

Whether the key may manage; see api_keys.management.

name
string
必填
organizationId
string | null
必填
prefix
string
必填

The first eight characters of the key body, for recognising a key in a list. Not a secret and not enough of one to be useful.

teamId
string | null
必填
token
string
必填
userId
string
必填