組織サービス アカウントのシークレットをローテーションする

POST /api/v1/organizations/{id}/service-accounts/{client_id}/rotate
Bearer 認証

組織内のスコープ指定されたカスタマーサービス アカウントの新しいシークレットを最小化します。前のシークレットは最大 7 日間（または、それより近い場合は独自の有効期限まで）機能し続けるため、呼び出しはダウンタイムなしでロールオーバーできます。ボディと secret_expires_ after_hours は任意です。省略値のデフォルトは2160（90 日）です。 OG_ADMIN が必要です。

path パラメータ

  • id string 必須

    組織ID

  • client_id string 必須

    サービス アカウントクライアントID （aa_SA_id_、レガシーagp_ sa_id_ ）

application/ JSON

body

任意のローテーションリクエスト、シークレットの有効期限を省略すると、デフォルトでは 90 日が設定されます

  • secret_expires_ after_hours integer

    任意のシークレット TTL（単位は時間）。デフォルトは 2160（90 日）で、空のローテーション本体を含みます。

応答

  • 406

    サポートされていないAPIバージョンまたは不正な API バージョン、選択した公開契約で利用できない操作、または受け入れができない表現（サポートされていないメディアタイプのパラメーター、または除外された SSE を含む）。既存の認証、認可、およびレート制限の失敗が優先されます。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        検証に失敗したフィールド。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        検証に失敗したフィールド。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。
  • 200

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • client_secret string
    • service_Account オブジェクト
      service_Account 属性を非表示にする service_Account 属性の表示 オブジェクト
      • Active_secret オブジェクト
        Active_secret 属性を非表示 Active_secret 属性の表示 オブジェクト
        • created_at string
        • expires_at string
        • last_used_at string
        • masked_value string
      • client_id string
      • created_at string
      • 説明 string
      • id string
      • ip_access_list array[string]
      • is_active ブール値
      • is_system_managed ブール値
      • name string
      • org_id string
      • 所有者 string
      • project_id string
      • role_assignments array[オブジェクト]
        role_assignments 属性を非表示にする role_assignments 属性の表示 オブジェクト
        • org_id string
        • project_id string
        • ロール string
      • タイプ string
      • Updated_at string
    応答属性の非表示 応答属性の表示 オブジェクト
    • client_secret string
    • service_Account オブジェクト
      service_Account 属性を非表示にする service_Account 属性の表示 オブジェクト
      • Active_secret オブジェクト
        Active_secret 属性を非表示 Active_secret 属性の表示 オブジェクト
        • created_at string
        • expires_at string
        • last_used_at string
        • masked_value string
      • client_id string
      • created_at string
      • 説明 string
      • id string
      • ip_access_list array[string]
      • is_active ブール値
      • is_system_managed ブール値
      • name string
      • org_id string
      • 所有者 string
      • project_id string
      • role_assignments array[オブジェクト]
        role_assignments 属性を非表示にする role_assignments 属性の表示 オブジェクト
        • org_id string
        • project_id string
        • ロール string
      • タイプ string
      • Updated_at string
  • 400

    無効なリクエスト

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 403

    Forbidden

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 404

    見つかりません

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 429

    リクエストが多すぎる

    ヘッダー属性を非表示 ヘッダー属性を表示
    • 再試行後 string

      再試行する前に待機する秒数

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 500

    内部サーバーエラー

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 503

    サービスは利用できません

    ヘッダー属性を非表示 ヘッダー属性を表示
    • 再試行後 string

      再試行する前に待機する秒数

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
POST /api/v1 /organizations/{id}/service-accounts/{client_id}/rotate 
curl \
 --request POST 'https://agentengine.mongodb.com/api/v1/organizations/{id}/service-accounts/{client_id}/rotate' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "secret_expires_after_hours": 42
}'
リクエスト例 
{
  "secret_expires_after_hours": 42
}
応答の例（406） 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
応答の例（406） 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
応答の例（200） 
{
  "client_secret": "string",
  "service_account": {
    "active_secret": {
      "created_at": "string",
      "expires_at": "string",
      "last_used_at": "string",
      "masked_value": "string"
    },
    "client_id": "string",
    "created_at": "string",
    "description": "string",
    "id": "string",
    "ip_access_list": [
      "string"
    ],
    "is_active": true,
    "is_system_managed": true,
    "name": "string",
    "org_id": "string",
    "owner": "string",
    "project_id": "string",
    "role_assignments": [
      {
        "org_id": "string",
        "project_id": "string",
        "role": "string"
      }
    ],
    "type": "string",
    "updated_at": "string"
  }
}
応答の例（200） 
{
  "client_secret": "string",
  "service_account": {
    "active_secret": {
      "created_at": "string",
      "expires_at": "string",
      "last_used_at": "string",
      "masked_value": "string"
    },
    "client_id": "string",
    "created_at": "string",
    "description": "string",
    "id": "string",
    "ip_access_list": [
      "string"
    ],
    "is_active": true,
    "is_system_managed": true,
    "name": "string",
    "org_id": "string",
    "owner": "string",
    "project_id": "string",
    "role_assignments": [
      {
        "org_id": "string",
        "project_id": "string",
        "role": "string"
      }
    ],
    "type": "string",
    "updated_at": "string"
  }
}
応答の例（400） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（400） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（403） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（403） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（404） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（404） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（429） 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（429） 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（500） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（500） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（503） 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（503） 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}