Get user registration state

Get user registration state

Tells whether a user is registered and whether it needs to set its password.

GEThttps://studio.edgeimpulse.com/v1/api-user-need-to-set-password/{usernameOrEmail}

Path parameters

usernameOrEmail*string

Username or email

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

emailstring

User email

needPasswordboolean

Whether the user needs to set its password or not

whitelabelsarray of string

White label domains the user belongs to, if any

trialsarray of EnterpriseTrial (object)

Current or past enterprise trials.

emailVerifiedboolean

Whether the user has verified its email address or not

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api-user-need-to-set-password/{usernameOrEmail}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "email": "text",
  "needPassword": false,
  "whitelabels": [
    "text"
  ],
  "trials": [
    {
      "created": "2024-07-04T17:46:38.493Z",
      "expirationDate": "2020-01-01T00:00:00Z",
      "notes": "This is a trial for the company's new project.",
      "expiredDate": "2024-07-04T17:46:38.493Z",
      "deletedDate": "2024-07-04T17:46:38.493Z",
      "upgradedDate": "2024-07-04T17:46:38.493Z"
    }
  ],
  "emailVerified": false
}