Create user

Create user

post

Create a new user and project. This API is no longer publicly available. Sign up at https://studio.edgeimpulse.com/signup instead.

Body

namestringRequired

Your name

Example: Jan Jongboom

usernamestringRequired

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

emailstringRequired

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

Example: [email protected]

passwordstringOptional

Password, minimum length 8 characters.

projectNamestringOptional

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

privacyPolicybooleanRequired

Whether the user accepted the privacy policy

activationTokenstringOptional

Activation token for users created via SSO

identityProviderstringOptional

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

jobTitlestringOptional

Job title of the user. Optional field

sessionIdstringOptional

Session ID. Optional field

companyNamestringOptional

ACME Inc.

ignoreEmailValidationbooleanOptional

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

turnstileResponsestringRequired

CloudFlare Turnstile response token

Responses

200

OK

application/json

Responseall of

post

HTTPcURLJavaScriptPython

POST /v1/api-user-create HTTP/1.1
Host: studio.edgeimpulse.com
Content-Type: application/json
Accept: */*
Content-Length: 356

{
  "name": "Jan Jongboom",
  "username": "janjongboom",
  "email": "[email protected]",
  "password": "text",
  "projectName": "text",
  "privacyPolicy": true,
  "activationToken": "text",
  "identityProvider": "text",
  "jobTitle": "text",
  "sessionId": "text",
  "companyName": "text",
  "utmParams": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "ignoreEmailValidation": true,
  "turnstileResponse": "text"
}

200

OK

{
  "success": true,
  "error": "text",
  "redirectUrl": "text",
  "id": 1
}