rds.logins.create

Create a login (read-only by default); the password goes to Secrets, never into the response

POST /rds/api/instances/{id}/loginsIAM rds:CreateDBLoginChanges state

Reveal the password with secrets get-value on the returned secretId (secrets:GetSecretValue, audited).

Request syntax

POST /rds/api/instances/{id}/logins
{
  "name": "string",
  "access": "enum",
  "forIamUserId": "string",
  "validUntil": "string"
}

Path parameters

  • idRequired

    string

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

Request body

  • nameRequired

    string

    The Postgres role name: a-z, 0-9, _

    Constraints: 1-63 chars

  • accessOptional

    enum

    read: SELECT on all data (pg_read_all_data); readwrite: also writes (pg_write_all_data); read when omitted

    One of: read, readwrite

    Default: "read"

  • forIamUserIdOptional

    string

    IAM user the login is for, shown with it; omitted: nobody in particular

    Constraints: uuid

  • validUntilOptional

    string

    Expiry (VALID UNTIL), 5 minutes to 2 years ahead; omitted is no expiry

    Constraints: datetime

Response

201 with { id, name, access, secretId }.

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

Fields of data

  • idAlways

    string

    Login id
  • nameAlways

    string

    PostgreSQL role name
  • accessAlways

    one of read, readwrite

    Access the role has
  • secretIdAlways

    string

    Secret holding the password (secrets get-value)

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:CreateDBLogin 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 create id --name 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_create.