---
title: "Register new user with application"
method: POST
path: "/register"
---

# Register new user with application

`POST /register`

## Query parameters

- `next` string

## Request body

- Register
  - `email` string, required — user identifier. This is by default an email address, but can be any (unique) field that is part of the User model and is defined in the __SECURITY_USER_IDENTITY_ATTRIBUTES__ configuration variable. It will also match against numeric User model fields.
  - `password` string, required — Password

## Response `200`

Register response

- DefaultJsonResponse
  - `meta` object, required
    - `code` integer, required — Http status code
  - `response` object, required
    - `user` object — By default an empty dictionary is returned. However by overriding _User::get_security_payload()_ any attributes of the User model can be returned.
    - `csrf_token` string — Session CSRF token

## Other responses

- `302` — Successful registration with form data body.
- `400` — Errors while validating registration form

## Changes

- **2023-10-22** `b647a0e917e6` — 1 breaking, 3 info
  - the response's body type/format changed from ``/`` to `object`/`` for status `400`
  - removed `#/components/schemas/BaseJsonResponse, subschema #2` from the response body `allOf` list for the response status `400`
  - added the required property `meta` to the response with the `400` status
  - added the required property `response` to the response with the `400` status
- **2022-07-22** `4b3ea48a957a` — 1 breaking, 2 warning, 2 info
  - the `allOf[subschema #2]/response/errors` response's property type/format changed from `object`/`` to `array`/`` for status `400`
  - removed the optional property `allOf[subschema #2]/response/error` from the response with the `400` status
  - removed the optional property `allOf[subschema #2]/response/errors/field-name` from the response with the `400` status
  - added the optional property `allOf[subschema #2]/response/field_errors` to the response with the `400` status
  - …1 more
- **2022-04-11** `afed188e0556` — 4 breaking, 2 warning, 2 info
  - the response's body type/format changed from `object`/`` to ``/`` for status `200`
  - the response's body type/format changed from `object`/`` to ``/`` for status `400`
  - removed the required property `meta` from the response with the `400` status
  - removed the required property `response` from the response with the `400` status
  - …4 more
- …earlier changes not shown

[Full history](https://skmtc.dev/pallets-eco/apis/flask-security-external-api/changes/register/post.md)

---

[API](https://skmtc.dev/pallets-eco/apis/flask-security-external-api.md) · [All operations](https://skmtc.dev/pallets-eco/apis/flask-security-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pallets-eco/flask-security-external-api/revisions/ee92f388dafa/schema)
