プロジェクトでの Atlasデータベースユーザーの更新

PATCH /api/v1/atlas/projects/{project_id}/database-users/{ユーザー名}

人間の呼び出し元の委任トークンまたはペアのエージェント エンジン サービス アカウントを使用して、Atlas Admin API PATCH /groups/{id}/databaseUsers/admin/{ユーザー名} をプロキシします。エージェント エンジンAPIキーは受け入れられません。パスワードをローテーションし、選択したクラスターにスコープが設定された管理者に対して readWriteAnyDatabase が付与されるため、 は、照合する置換を作成する代わりに、既存のワークスペースの名前付きユーザーを再利用できます。パスワードは、エラー応答またはログに表示されることはありません。無効な project_id またはユーザー名は、Atlas を呼び出す前に拒否されます。作成と同じ Atlas プロジェクト オーナー ゲートが必要です。

path パラメータ

  • project_id string 必須

    AtlasプロジェクトID

  • username string 必須

    Atlasデータベースのユーザー名

application/ JSON
body オブジェクト 必須

データベースユーザーの更新

次の 1 つ:

応答

  • サポートされていない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

    応答属性を非表示 応答属性の表示 オブジェクト
    • username string
    応答属性を非表示 応答属性の表示 オブジェクト
    • username string
  • 無効なリクエスト

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 許可されていない

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

    Atlas_PAYMENT_METHOD_REQUERED

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

    Atlas_PERMISSION_REQUERED、Atlas_SERVICE_ACCOUNT_NOT_PAILED、または 禁止

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

    NULL_FOUND

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

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

    リクエスト本文が大きすぎる

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

    InterNAL_ERROR

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

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

    PLATCOM:

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
PATCH /api/v1 /atlas/projects/{{project_id}/database-users/{ユーザー名}
curl \
 --request PATCH 'https://agentengine.mongodb.com/api/v1/atlas/projects/{project_id}/database-users/{username}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json"
リクエスト例
{}
{
  "cluster_name": "string",
  "password": "string"
}
応答の例(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)
{
  "username": "string"
}
応答の例(200)
{
  "username": "string"
}
応答の例(400)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(400)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(401)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(401)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(402)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(402)
{
  "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
}
応答の例(409)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(409)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(413)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(413)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(500)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(500)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(502)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(502)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(503)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(503)
{
  "code": "string",
  "error": "string",
  "success": true
}