2005: Request onetime-password

Requests that the API generate a onetime-password to be emailed to an entity email address. The password can then be used to authenticate using authType: onetime, with endpoint 2001: Authenticate.

Requires Data Isolation to be enabled.

Endpoint ID:	2005
Method:	GET
URL:	/entity/authenticate/onetime/email/{email}
	email	The email to be found in the database and subsequently be sent a newly generated onetime-password
Request body	None
Response body	None
Status codes	204	Success. Password reminder or reset notification was sent
	403	A forbidden response with ApiStatusSubCode 403.10 maybe returned when a previous onetime-password has had its maximum login attempts exceeded, and is currently locked
	404	No account with specified email was found in the database

REST API

2005: Request onetime-password

Analytics

Related content