Retrieve an Existing Database User

v1.0.0

To show information about an existing database user, send a GET request to /v2/databases/$DATABASE_ID/users/$USERNAME.

Note: User management is not supported for Redis clusters.

The response will be a JSON object with a user key. This will be set to an object containing the standard database user attributes.

For MySQL clusters, additional options will be contained in the mysql_settings object.

Input

{
  "type": "object",
  "properties": {
    "database_cluster_uuid": {
      "type": "string",
      "format": "uuid"
    },
    "username": {
      "type": "string"
    }
  },
  "required": [
    "database_cluster_uuid",
    "username"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "user"
  ],
  "properties": {
    "user": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "mysql_settings": {
          "type": "object",
          "required": [
            "auth_plugin"
          ],
          "properties": {
            "auth_plugin": {
              "type": "string",
              "description": "A string specifying the authentication method to be used for connections\nto the MySQL user account. The valid values are `mysql_native_password`\nor `caching_sha2_password`. If excluded when creating a new user, the\ndefault for the version of MySQL in use will be used. As of MySQL 8.0, the\ndefault is `caching_sha2_password`.\n",
              "enum": [
                "mysql_native_password",
                "caching_sha2_password"
              ]
            }
          }
        },
        "name": {
          "type": "string",
          "description": "The name of a database user."
        },
        "password": {
          "type": "string",
          "description": "A randomly generated password for the database user."
        },
        "role": {
          "type": "string",
          "description": "A string representing the database user's role. The value will be either\n\"primary\" or \"normal\".\n",
          "enum": [
            "primary",
            "normal"
          ]
        }
      }
    }
  }
}