postUsersForgotpassword

Initiates the forgot password process for a local user

Requires authentication as user

postUsersForgotpassword

Request

post /Users/ForgotPassword

Parameters

Name	In	Type	Default	Notes
*body	body	ForgotPassword		ForgotPassword

Responses

Status Code	Type	Description	Samples
200	ForgotPasswordResult	Operation successful. Returning a ForgotPasswordResult object.
400		Bad Request. Server cannot process request.
401		Unauthorized. Client needs to authenticate.
403		Forbidden. No permission for the reqested operation.
404		Resource not found or unavailable.
500		Server error.

Definitions

ForgotPassword

Emby.Api.ForgotPassword

Name	Type	Notes
EnteredUsername	string

ForgotPasswordResult

see also MediaBrowser.Model.Users.ForgotPasswordResult

Name	Type	Notes
Action	ForgotPasswordAction
PinFile	string	The pin file.
PinExpirationDate	string (date-time)	The pin expiration date.

ForgotPasswordAction

see also MediaBrowser.Model.Users.ForgotPasswordAction

Enum Values

• ContactAdmin
• PinCode