Skip to main content
PATCH
Inboxes - Delete API Key

授权

Authorization
string
header
必填

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

路径参数

api_key_id
string
必填

API 密钥的 ID。

inbox_id
string
必填

收件箱的 ID。

请求体

application/json

Rename a credential or change its permissions. Key material, type, scope, and expiry are immutable.

name
string

API 密钥的名称。

permissions
ApiKeyPermissions · object

API 密钥的细粒度权限。省略时授予所有权限;否则,仅授予设置为 true 的权限。

响应

状态码为 200 的响应

An API key presented as a bearer token in the Authorization header.

type
enum<string>
必填
可用选项:
bearer
api_key_id
string
必填

API 密钥的 ID。

prefix
string
必填

API 密钥的前缀。

name
string
必填

API 密钥的名称。

created_at
string<date-time>
必填

API 密钥的创建时间。

updated_at
string<date-time>
必填

Time at which api key was last updated.

pod_id
string

API 密钥作用域所限定的 Pod ID。设置后,该密钥只能访问此 Pod 内的资源。

inbox_id
string

API 密钥限定访问的收件箱 ID。如果设置,该密钥只能访问此收件箱内的资源。

used_at
string<date-time>

API 密钥上次使用的时间。

permissions
ApiKeyPermissions · object

API 密钥的细粒度权限。省略时授予所有权限;否则,仅授予设置为 true 的权限。

expires_at
string<date-time>

Time at which api key expires. Omitted when it does not expire.