Auth.Api

<back to all web services

UserForgotPasswordDTO

The following routes are available for this service:
POST/admin/v1/users/forgot-password
UserForgotPasswordDTO Parameters:
NameParameterData TypeRequiredDescription
PublicKeybodystringNo
Users Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
FirstNameformstringNo
LastNameformstringNo
IsEnabledformboolNo
RecordStatusIdformintNo
TwoFactorEnabledformboolNo
PhoneNumberConfirmedformboolNo
PhoneNumberformstringNo
SecurityStampformstringNo
EmailConfirmedformboolNo
NormalizedEmailformstringNo
EmailformstringNo
NormalizedUserNameformstringNo
UsernameformstringNo
LockoutEnabledformboolNo
AccessFailedCountformintNo
ApplicationLanguagesIdformint?No
TimezonesIdformint?No
UsersResponse Parameters:
NameParameterData TypeRequiredDescription
UsersformUsersNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /admin/v1/users/forgot-password HTTP/1.1 
Host: auth.mepis.si 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserForgotPasswordDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel">
  <AccessFailedCount xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">0</AccessFailedCount>
  <ApplicationLanguagesId xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">0</ApplicationLanguagesId>
  <Email xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">String</Email>
  <EmailConfirmed xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">false</EmailConfirmed>
  <FirstName xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">String</FirstName>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">0</Id>
  <IsEnabled xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">false</IsEnabled>
  <LastName xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">String</LastName>
  <LockoutEnabled xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">false</LockoutEnabled>
  <NormalizedEmail xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">String</NormalizedEmail>
  <NormalizedUserName xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">String</NormalizedUserName>
  <PhoneNumber xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">String</PhoneNumber>
  <PhoneNumberConfirmed xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">false</PhoneNumberConfirmed>
  <RecordStatusId xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">0</RecordStatusId>
  <SecurityStamp xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">String</SecurityStamp>
  <TimezonesId xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">0</TimezonesId>
  <TwoFactorEnabled xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">false</TwoFactorEnabled>
  <Username xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">String</Username>
  <PublicKey>String</PublicKey>
</UserForgotPasswordDTO>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel">
  <Users xmlns:d2p1="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">
    <d2p1:AccessFailedCount>0</d2p1:AccessFailedCount>
    <d2p1:ApplicationLanguagesId>0</d2p1:ApplicationLanguagesId>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:EmailConfirmed>false</d2p1:EmailConfirmed>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:IsEnabled>false</d2p1:IsEnabled>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:LockoutEnabled>false</d2p1:LockoutEnabled>
    <d2p1:NormalizedEmail>String</d2p1:NormalizedEmail>
    <d2p1:NormalizedUserName>String</d2p1:NormalizedUserName>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:PhoneNumberConfirmed>false</d2p1:PhoneNumberConfirmed>
    <d2p1:RecordStatusId>0</d2p1:RecordStatusId>
    <d2p1:SecurityStamp>String</d2p1:SecurityStamp>
    <d2p1:TimezonesId>0</d2p1:TimezonesId>
    <d2p1:TwoFactorEnabled>false</d2p1:TwoFactorEnabled>
    <d2p1:Username>String</d2p1:Username>
  </Users>
</UsersResponse>