EDedgeimpulse
User

Get user registration state

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

get/api-user-need-to-set-password/{usernameOrEmail}

Request

Path parameters

usernameOrEmailstring required

Username or email

Response

OK

successboolean required

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

whitelabelsstring[]

White label domains the user belongs to, if any

emailVerifiedboolean

Whether the user has verified its email address or not

idpsstring[]

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

Example response

{
  "trials": [
    {
      "expirationDate": "2020-01-01T00:00:00Z",
      "notes": "This is a trial for the company's new project."
    }
  ],
  "idps": [
    "okta",
    "google"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.