Skip to content

Register a new user

POST
/api/register

If the server configuration allows it, this endpoint enables the registration of a new user. Depending on the server configuration, a confirmation email may be sent to the provided email address so that the user can verify their email address.

The new User resource

object
email
required

More information

string format: email
password
required
string | null

User resource created

object
@context
One of:
string
@id
string
@type
string
id
integer
email
required

More information

string format: email
roles

The user roles

Array<string>
password
required
string | null
watchlists
Array<string>
connectors
Array<string>
createdAt
string format: date-time
verifiedAt
string | null format: date-time
domainPurchases
Array<object>
object
@context
One of:
string
@id
string
@type
string
id
string | null
domain
string | null format: iri-reference
Example
https://example.com/
domainUpdatedAt
string format: date-time
domainOrderedAt
string | null format: date-time
connectorProvider
string
Allowed values: ovh gandi autodns namecheap namecom epp
connector
string | null format: iri-reference
Example
https://example.com/
user
string | null format: iri-reference
Example
https://example.com/
domainDeletedAt
string format: date-time
userIdentifier

A visual identifier that represents this user.

string

Invalid input

Unprocessable entity