Register with email and password

POST /v2/register/

API version

v2

Request method

POST

Operation ID

user-register

---

Request

Responses

Format

application/json

Description

Registration was successfull. A verification email will be sent to the specified email address. The users can be used as soon as the verification link was opened

Schema documentation

• userIdstring (uuid)

  required

Example

{
  "userId": "f0f86186-0a5a-45b2-aa33-502777496347"
}

JSON Schema

{
  "properties": {
    "userId": {
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "userId"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"email":"email@mittwald.example","password":"string","person":{"firstName":"Ada","lastName":"Lovelace","title":"mr"}}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/register

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.user.register({
  "data": {
    "email": "email@mittwald.example",
    "password": "string",
    "person": {
      "firstName": "Ada",
      "lastName": "Lovelace",
      "title": "mr"
    }
  }
});

assertStatus(response, 201);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\User\Register\RegisterRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\User\Register\RegisterRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// RegisterRequestBody to learn how to construct a valid instance
$body = new RegisterRequestBody(/* TODO: ... */);

$request = (new RegisterRequest(
  body: $body
));
$response = $client->user()->register($request);

var_dump($response->getBody();