List MySQL users belonging to a Database

GET/mysql-databases/{mysqlDatabaseId}/users/

API version

v2

Request method

GET

Operation ID

database-list-mysql-users

---

Request

• mysqlDatabaseIdstring (uuid)

  required

  ID of the MySQLDatabase to list Users for.

Responses

Format

application/json

Description

OK

Schema documentation

• Array[
• *object
  • accessIpMaskstring
  • accessLevelstring (one of: full, readonly)

    required
  • createdAtstring (date-time)

    required
  • databaseIdstring (uuid)

    required
  • descriptionstring
  • disabledboolean

    required
  • externalAccessboolean

    required
  • idstring (uuid)

    required
  • mainUserboolean

    required
  • namestring

    required
  • passwordUpdatedAtstring (date-time)

    required
  • statusstring (one of: pending, ready, error, terminating, disabled)

    required
  • statusSetAtstring (date-time)

    required
  • updatedAtstring (date-time)

    required
]

Example

[
  {
    "accessIpMask": "string",
    "accessLevel": "full",
    "createdAt": "2024-12-27T00:28:22.193Z",
    "databaseId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "description": "string",
    "disabled": true,
    "externalAccess": true,
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "mainUser": true,
    "name": "string",
    "passwordUpdatedAt": "2024-12-27T00:28:22.193Z",
    "status": "pending",
    "statusSetAt": "2024-12-27T00:28:22.193Z",
    "updatedAt": "2024-12-27T00:28:22.193Z"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "accessIpMask": {
        "type": "string"
      },
      "accessLevel": {
        "enum": [
          "full",
          "readonly"
        ],
        "type": "string"
      },
      "createdAt": {
        "format": "date-time",
        "type": "string"
      },
      "databaseId": {
        "format": "uuid",
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "disabled": {
        "type": "boolean"
      },
      "externalAccess": {
        "type": "boolean"
      },
      "id": {
        "format": "uuid",
        "type": "string"
      },
      "mainUser": {
        "type": "boolean"
      },
      "name": {
        "type": "string"
      },
      "passwordUpdatedAt": {
        "format": "date-time",
        "type": "string"
      },
      "status": {
        "enum": [
          "pending",
          "ready",
          "error",
          "terminating",
          "disabled"
        ],
        "type": "string"
      },
      "statusSetAt": {
        "format": "date-time",
        "type": "string"
      },
      "updatedAt": {
        "format": "date-time",
        "type": "string"
      }
    },
    "required": [
      "id",
      "createdAt",
      "updatedAt",
      "databaseId",
      "name",
      "passwordUpdatedAt",
      "mainUser",
      "disabled",
      "accessLevel",
      "externalAccess",
      "status",
      "statusSetAt"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/mysql-databases/f0f86186-0a5a-45b2-aa33-502777496347/users

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.database.listMysqlUsers({
  "mysqlDatabaseId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Database\ListMysqlUsers\ListMysqlUsersRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ListMysqlUsersRequest(
  mysqlDatabaseId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->database()->listMysqlUsers($request);

var_dump($response->getBody();