rds.logins.modify

Set or clear a login's expiry, at least five minutes ahead (to cut off now, revoke)

PATCH /rds/api/instances/{id}/logins/{loginId}IAM rds:ModifyDBLoginChanges state

Postgres checks VALID UNTIL at connect; the expiry sweep ends sessions still open when it passes.

Request syntax

PATCH /rds/api/instances/{id}/logins/{loginId}
{
  "validUntil": "string"
}

Path parameters

  • idRequired

    string

    Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/

  • loginIdRequired

    string

    Constraints: uuid

Request body

  • validUntilRequired

    string

    New expiry, 5 minutes to 2 years ahead; null removes the expiry

    Constraints: datetime

    May be null.

Response

200 with { id, validUntil } (null for no expiry).

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • idAlways

    string

    Login id
  • validUntilAlways

    string, may be null

    New expiry; null: none

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow rds:ModifyDBLogin on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud rds logins modify id loginId --valid-until example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_logins_modify.