GET
/
api-user-need-to-set-password
/
{usernameOrEmail}
Get user registration state
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api-user-need-to-set-password/{usernameOrEmail}
{
  "success": true,
  "error": "<string>",
  "email": "<string>",
  "needPassword": true,
  "whitelabels": [
    "<string>"
  ],
  "trials": [
    {
      "id": 123,
      "userId": 123,
      "organizationId": 123,
      "created": "2023-11-07T05:31:56Z",
      "expirationDate": "2020-01-01T00:00:00Z",
      "notes": "This is a trial for the company's new project.",
      "expiredDate": "2023-11-07T05:31:56Z",
      "deletedDate": "2023-11-07T05:31:56Z",
      "upgradedDate": "2023-11-07T05:31:56Z"
    }
  ],
  "emailVerified": true,
  "idps": [
    "okta",
    "google"
  ]
}

Path Parameters

usernameOrEmail
string
required

Username or email

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

error
string

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

email
string

User email

needPassword
boolean

Whether the user needs to set its password or not

whitelabels
string[]

White label domains the user belongs to, if any

trials
object[]

Current or past enterprise trials.

emailVerified
boolean

Whether the user has verified its email address or not

idps
string[]

List of unique identifiers for identity providers associated with the user.

Example:
["okta", "google"]