---
title: "Get user registration state"
method: GET
path: "/api-user-need-to-set-password/{usernameOrEmail}"
tags: ["User"]
---

# Get user registration state

`GET /api-user-need-to-set-password/{usernameOrEmail}`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api-user-need-to-set-password/{usernameOrEmail}`
- Auth: none required
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api-user-need-to-set-password/:usernameOrEmail/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `usernameOrEmail` string, required

## Response `200`

OK

- GetUserNeedToSetPasswordResponse
  - `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` EnterpriseTrial[]: Current or past enterprise trials.
    - `id` integer, required: Unique identifier of the trial.
    - `userId` integer, required: ID of the user who created the trial.
    - `organizationId` integer, required: ID of the organization created for the trial.
    - `created` string, date-time, required: Date when the trial was created. Trials start immediately on creation.
    - `expirationDate` string, date-time, required: Expiration date of the trial. The trial will be set as expired after this date. There will be a grace period of 30 days after a trial expires before fully deleting the trial organization. This field is ignored if the trial is requested by a non-admin user, defaulting to 14 days trial.
    - `notes` string: Notes about the trial. Free form text. This field is ignored if the trial is requested by a non-admin user.
    - `expiredDate` string, date-time, nullable, required: Date when the trial actually expired. This is set when the trial is expired by the system.
    - `deletedDate` string, date-time, nullable, required: Date when the trial was deleted. This is set when the trial is fully deleted by the system.
    - `upgradedDate` string, date-time, nullable, required: Date when the trial was upgraded to a full enterprise account.
  - `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.

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)