Get a MySQL user

GET/mysql-users/{mysqlUserId}/

API version

v2

Request method

GET

Operation ID

database-get-mysql-user

---

Request

• mysqlUserIdstring (uuid)

  required

  ID of the MySQLUser to be retrieved.

Responses

Format

application/json

Description

OK

Schema documentation

• 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:21.922Z",
  "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:21.922Z",
  "status": "pending",
  "statusSetAt": "2024-12-27T00:28:21.922Z",
  "updatedAt": "2024-12-27T00:28:21.922Z"
}

JSON Schema

{
  "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"
}

Usage examples

cURL

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

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.getMysqlUser({
  "mysqlUserId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new GetMysqlUserRequest(
  mysqlUserId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->database()->getMysqlUser($request);

var_dump($response->getBody();