rds.logins.list

List logins with who each is for, whether its role is on the server, and its open sessions

GET /rds/api/instances/{id}/loginsIAM rds:DescribeDBLoginsRead

Request syntax

GET /rds/api/instances/{id}/logins

Path parameters

  • idRequired

    string

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

Response

200 with logins (id, name, access, secretId, forIamUserId, forUsername, createdByUsername, createdAt, validUntil, expired, serverValidUntil, passwordRotatedAt, onServer, sessions) and serverError when the server could not be asked.

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

Fields of data

  • loginsAlways

    array of object

    Logins of the database, by name
  • logins[].​idAlways

    string

    Login id
  • logins[].​nameAlways

    string

    PostgreSQL role name
  • logins[].​accessAlways

    one of read, readwrite

    read: SELECT on all data; readwrite: writes too
  • logins[].​secretIdAlways

    string, may be null

    Secret holding the password; null once it is gone
  • logins[].​forIamUserIdAlways

    string, may be null

    IAM user the login is for; null: nobody in particular
  • logins[].​forUsernameAlways

    string, may be null

    That IAM user’s name
  • logins[].​createdByUsernameAlways

    string, may be null

    IAM user who created it; null once that user is deleted
  • logins[].​createdAtAlways

    string

    When it was created
  • logins[].​validUntilAlways

    string, may be null

    Expiry; null: none
  • logins[].​expiredAlways

    boolean

    The expiry has passed
  • logins[].​serverValidUntilWhen present

    string, may be null

    The expiry the server enforces, when it differs from validUntil (changed by hand); absent when they agree
  • logins[].​passwordRotatedAtAlways

    string, may be null

    When the password was last rotated; null: never
  • logins[].​onServerAlways

    boolean, may be null

    The role exists on the server and can log in; null: not asked
  • logins[].​sessionsAlways

    number, may be null

    Open sessions of the role; null: not asked
  • serverErrorAlways

    string, may be null

    Why the server could not be asked; null when it was or did not need to be

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:DescribeDBLogins 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 list id

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