POST
/
api-user-create
Create user
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api-user-create \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Jan Jongboom",
  "username": "janjongboom",
  "email": "jan@edgeimpulse.com",
  "password": "<string>",
  "projectName": "<string>",
  "privacyPolicy": true,
  "activationToken": "<string>",
  "identityProvider": "<string>",
  "jobTitle": "<string>",
  "sessionId": "<string>",
  "companyName": "<string>",
  "utmParams": [
    {}
  ],
  "ignoreEmailValidation": true,
  "turnstileResponse": "<string>"
}'
{
  "success": true,
  "error": "<string>",
  "redirectUrl": "<string>",
  "id": 123
}

Body

application/json
​
name
string
required

Your name

Example:

"Jan Jongboom"

​
username
string
required

Username, minimum 4 and maximum 30 characters. May contain alphanumeric characters, hyphens, underscores and dots. Validated according to ^(?=.{4,30}$)(?![_.])(?!.*[_.]{2})[a-zA-Z0-9._-]+(?<![_.])$.

Example:

"janjongboom"

​
email
string
required

E-mail address. Will need to be validated before the account will become active.

Example:

"jan@edgeimpulse.com"

​
privacyPolicy
boolean
required

Whether the user accepted the privacy policy

​
turnstileResponse
string
required

CloudFlare Turnstile response token

​
password
string

Password, minimum length 8 characters.

​
projectName
string

A project will automatically be created. Sets the name of the first project. If not set, this will be derived from the username.

​
activationToken
string

Activation token for users created via SSO

​
identityProvider
string

Unique identifier of the identity provider asserting the identity of this user

​
jobTitle
string

Job title of the user. Optional field

​
sessionId
string

Session ID. Optional field

​
companyName
string

ACME Inc.

​
utmParams
object[]

List of UTM parameters.

​
ignoreEmailValidation
boolean

If true, allows signup to proceed despite a potentially invalid email. Note that this will enforce email verification post-signup

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
error
string

Optional error description (set if 'success' was false)

​
redirectUrl
string

URL to redirect user to.

​
id
integer

User unique identifier