Create or login a user

Create or login a user

Login as a user as a third-party authentication provider. If the user does not exists, it's automatically created. You can only log in as users that were previously created by you.

POSThttps://studio.edgeimpulse.com/v1/api/third-party-auth/{authId}/login

Path parameters

authId*integer

Auth ID

Body

application/json

name*string

Your name

Example: "Jan Jongboom"

username*string

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

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

Example: "[e-mail]"

projectNamestring

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

privacyPolicy*boolean

Whether the user accepted the privacy policy

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

status*enum

userWasCreateduserNotManagedByThirdPartyuserAlreadyExists

jwtTokenstring

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/third-party-auth/{authId}/login', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Jan Jongboom",
      "username": "janjongboom",
      "email": "[e-mail]",
      "privacyPolicy": false
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "status": "userWasCreated",
  "jwtToken": "text"
}