POST Api/WebUtilities/ForgotPassword

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
User	UserDTO	None.
Link	string	None.
ClientPublicKey	string	None.
SecurityToken	string	None.
CurrentUserId	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "user": {
    "id": "72cb384a-0abb-4ba8-8e22-13748a057352",
    "username": "sample string 2",
    "password": "sample string 3",
    "email": "sample string 4",
    "accountId": "fb95eb8e-810c-4475-a535-18bd75423a36",
    "userType": {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3"
    },
    "products": [
      {
        "id": 1,
        "portal": {
          "id": 1,
          "name": "sample string 2",
          "description": "sample string 3",
          "clientPublicKey": "sample string 4",
          "securityToken": "sample string 5",
          "currentUserId": "6961b300-5784-4963-97b7-68f2620aea16"
        },
        "tool": {
          "id": 1,
          "name": "sample string 2",
          "shortName": "sample string 3",
          "logoUrl": "sample string 4",
          "order": 5,
          "description": "sample string 6",
          "author": "sample string 7",
          "ageRange": "sample string 8",
          "clientPublicKey": "sample string 9",
          "securityToken": "sample string 10",
          "currentUserId": "d902035a-fc1b-47ed-91ac-72084178927c"
        },
        "clientPublicKey": "sample string 2",
        "securityToken": "sample string 3",
        "currentUserId": "9a88bb66-e27e-49f2-8e48-8afa729aa3e2"
      },
      {
        "id": 1,
        "portal": {
          "id": 1,
          "name": "sample string 2",
          "description": "sample string 3",
          "clientPublicKey": "sample string 4",
          "securityToken": "sample string 5",
          "currentUserId": "6961b300-5784-4963-97b7-68f2620aea16"
        },
        "tool": {
          "id": 1,
          "name": "sample string 2",
          "shortName": "sample string 3",
          "logoUrl": "sample string 4",
          "order": 5,
          "description": "sample string 6",
          "author": "sample string 7",
          "ageRange": "sample string 8",
          "clientPublicKey": "sample string 9",
          "securityToken": "sample string 10",
          "currentUserId": "d902035a-fc1b-47ed-91ac-72084178927c"
        },
        "clientPublicKey": "sample string 2",
        "securityToken": "sample string 3",
        "currentUserId": "9a88bb66-e27e-49f2-8e48-8afa729aa3e2"
      }
    ],
    "firstName": "sample string 6",
    "lastName": "sample string 7",
    "oneId": "4ebe7c3b-70fc-407f-a02e-36608f9aacc3",
    "verificationDate": "2025-07-01T06:27:04.1980636-04:00",
    "verificationCode": "sample string 9",
    "clientPublicKey": "sample string 10",
    "securityToken": "sample string 11",
    "currentUserId": "3cc51e8d-7daa-441f-8616-127f55beda5e"
  },
  "link": "sample string 1",
  "clientPublicKey": "sample string 2",
  "securityToken": "sample string 3",
  "currentUserId": "fe438482-b85c-4dcf-b598-ebc911cc3000"
}

application/xml, text/xml

Sample:

<PasswordResetDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AccessManager.DTO">
  <ClientPublicKey>sample string 2</ClientPublicKey>
  <CurrentUserId>fe438482-b85c-4dcf-b598-ebc911cc3000</CurrentUserId>
  <SecurityToken>sample string 3</SecurityToken>
  <Link>sample string 1</Link>
  <User>
    <ClientPublicKey>sample string 10</ClientPublicKey>
    <CurrentUserId>3cc51e8d-7daa-441f-8616-127f55beda5e</CurrentUserId>
    <SecurityToken>sample string 11</SecurityToken>
    <AccountId>fb95eb8e-810c-4475-a535-18bd75423a36</AccountId>
    <Email>sample string 4</Email>
    <FirstName>sample string 6</FirstName>
    <Id>72cb384a-0abb-4ba8-8e22-13748a057352</Id>
    <LastName>sample string 7</LastName>
    <OneId>4ebe7c3b-70fc-407f-a02e-36608f9aacc3</OneId>
    <Password>sample string 3</Password>
    <Products>
      <ProductDTO>
        <ClientPublicKey>sample string 2</ClientPublicKey>
        <CurrentUserId>9a88bb66-e27e-49f2-8e48-8afa729aa3e2</CurrentUserId>
        <SecurityToken>sample string 3</SecurityToken>
        <Id>1</Id>
        <Portal>
          <ClientPublicKey>sample string 4</ClientPublicKey>
          <CurrentUserId>6961b300-5784-4963-97b7-68f2620aea16</CurrentUserId>
          <SecurityToken>sample string 5</SecurityToken>
          <Description>sample string 3</Description>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Portal>
        <Tool>
          <ClientPublicKey>sample string 9</ClientPublicKey>
          <CurrentUserId>d902035a-fc1b-47ed-91ac-72084178927c</CurrentUserId>
          <SecurityToken>sample string 10</SecurityToken>
          <AgeRange>sample string 8</AgeRange>
          <Author>sample string 7</Author>
          <Description>sample string 6</Description>
          <Id>1</Id>
          <LogoUrl>sample string 4</LogoUrl>
          <Name>sample string 2</Name>
          <Order>5</Order>
          <ShortName>sample string 3</ShortName>
        </Tool>
      </ProductDTO>
      <ProductDTO>
        <ClientPublicKey>sample string 2</ClientPublicKey>
        <CurrentUserId>9a88bb66-e27e-49f2-8e48-8afa729aa3e2</CurrentUserId>
        <SecurityToken>sample string 3</SecurityToken>
        <Id>1</Id>
        <Portal>
          <ClientPublicKey>sample string 4</ClientPublicKey>
          <CurrentUserId>6961b300-5784-4963-97b7-68f2620aea16</CurrentUserId>
          <SecurityToken>sample string 5</SecurityToken>
          <Description>sample string 3</Description>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </Portal>
        <Tool>
          <ClientPublicKey>sample string 9</ClientPublicKey>
          <CurrentUserId>d902035a-fc1b-47ed-91ac-72084178927c</CurrentUserId>
          <SecurityToken>sample string 10</SecurityToken>
          <AgeRange>sample string 8</AgeRange>
          <Author>sample string 7</Author>
          <Description>sample string 6</Description>
          <Id>1</Id>
          <LogoUrl>sample string 4</LogoUrl>
          <Name>sample string 2</Name>
          <Order>5</Order>
          <ShortName>sample string 3</ShortName>
        </Tool>
      </ProductDTO>
    </Products>
    <UserType>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </UserType>
    <Username>sample string 2</Username>
    <VerificationCode>sample string 9</VerificationCode>
    <VerificationDate>2025-07-01T06:27:04.1980636-04:00</VerificationDate>
  </User>
</PasswordResetDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PasswordResetDTO'.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>