Skip to main content
POST
サービスユーザーのAPIキーをローテーション

権限

Enterprise レベルの ManageAccountServiceUsers 権限を持つサービスユーザーが必要です。

承認

Authorization
string
header
必須

サービスユーザーの認証情報(接頭辞: cog_)

パスパラメータ

service_user_id
string
必須

サービスユーザーID(プレフィックス: service-user-)

:

"service-user-abc123def456"

api_key_id
string
必須

ボディ

application/json
new_key_expires_at
integer | null

新しい key の省略可能な有効期限(秒単位の UNIX タイムスタンプ)。有効期限なしの場合は null。

revoke_current
boolean
デフォルト:true

現在の key を取り消すかどうか。段階的な切り替えを行うには False に設定します。

レスポンス

成功レスポンス

APIキーの作成/ローテーションに関する共通レスポンスモデル(1回限りのトークンを含む)。

api_key_id
string
必須
api_key_name
string
必須
token
string
必須

生のAPIトークンです。これは作成時またはローテーション時に1回だけ表示されます。