轮换服务用户的 API 密钥

轮换服务用户的 API 密钥。

创建一个新密钥。默认会撤销旧密钥；将 revoke_current=false 设为 false 可实现平滑轮换，使两个密钥暂时同时保持有效。 如果未找到该密钥，则返回 404；如果该密钥未处于有效状态，则返回 400。

POST /v3beta1/enterprise/service-users/{service_user_id}/api-keys/{api_key_id}/rotate

轮换服务用户的 API 密钥

cURL

curl --request POST \
  --url https://api.devin.ai/v3beta1/enterprise/service-users/{service_user_id}/api-keys/{api_key_id}/rotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_key_expires_at": 123,
  "revoke_current": true
}
'

import requests

url = "https://api.devin.ai/v3beta1/enterprise/service-users/{service_user_id}/api-keys/{api_key_id}/rotate"

payload = {
    "new_key_expires_at": 123,
    "revoke_current": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({new_key_expires_at: 123, revoke_current: true})
};

fetch('https://api.devin.ai/v3beta1/enterprise/service-users/{service_user_id}/api-keys/{api_key_id}/rotate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.devin.ai/v3beta1/enterprise/service-users/{service_user_id}/api-keys/{api_key_id}/rotate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'new_key_expires_at' => 123,
    'revoke_current' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.devin.ai/v3beta1/enterprise/service-users/{service_user_id}/api-keys/{api_key_id}/rotate"

	payload := strings.NewReader("{\n  \"new_key_expires_at\": 123,\n  \"revoke_current\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.devin.ai/v3beta1/enterprise/service-users/{service_user_id}/api-keys/{api_key_id}/rotate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"new_key_expires_at\": 123,\n  \"revoke_current\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.devin.ai/v3beta1/enterprise/service-users/{service_user_id}/api-keys/{api_key_id}/rotate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"new_key_expires_at\": 123,\n  \"revoke_current\": true\n}"

response = http.request(request)
puts response.read_body

200

{
  "api_key_id": "<string>",
  "api_key_name": "<string>",
  "token": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

​

权限

需要具备企业级 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

新密钥的可选过期时间，以秒为单位的 UNIX 时间戳。Null 表示不过期。

revoke_current · boolean · 默认值: true

是否撤销当前密钥。设为 False 可进行平滑轮换。

响应

200

application/json

成功响应

API 密钥创建/轮换的共享响应模型（包含一次性令牌）。

api_key_id · string · 必填

api_key_name · string · 必填

token · string · 必填

原始 API 令牌。该令牌仅会在创建或轮换时显示一次。