メインコンテンツへスキップ
POST
サービスユーザーのAPIキーをローテーション

権限

Enterprise レベルの ManageAccountServiceUsers 権限を持つサービスユーザーまたはパーソナルアクセストークンが必要です。

承認

Authorization
string
header
必須

サービスユーザーの credential(プレフィックス: cog_)

パスパラメータ

service_user_id
string
必須

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

例:

"service-user-abc123def456"

api_key_id
string
必須

ボディ

application/json
new_key_expires_at
integer | null

新しいキーの有効期限を、任意で秒単位のUNIXタイムスタンプとして指定します。nullの場合は有効期限なしです。

revoke_current
boolean
デフォルト:true

現在のキーを失効させるかどうか。円滑に切り替えるには、Falseに設定します。

レスポンス

成功レスポンス

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

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

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