Password

Toggle Pane

• Password
  • getValidates a password set link using the provided key
  • postSets a new password using the validated password set link
  • getValidates a password reset link using the provided key
  • postResets a password using the validated password reset link

API docs by Redocly

Download OpenAPI Specification: Download

Password

Validates a password set link using the provided key

Authorizations:

ApiKeyBearer

query Parameters

key	string <uuid> Unique identifier for the password set operation

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

key	string <uuid>
mfaEnabled	boolean
username	string or null
password	string or null
confirmPassword	string or null

https://us.thruinc.com/api/Password/validate

https://uk.thruinc.com/api/Password/validate

https://eu.thruinc.com/api/Password/validate

https://au.thruinc.com/api/Password/validate

Response samples

• 200
• 400
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Sets a new password using the validated password set link

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Password model containing the key, new password, and confirmation

key	string <uuid>
mfaEnabled	boolean
username	string or null
password	string or null
confirmPassword	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

string

https://us.thruinc.com/api/Password/setPassword

https://uk.thruinc.com/api/Password/setPassword

https://eu.thruinc.com/api/Password/setPassword

https://au.thruinc.com/api/Password/setPassword

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
• "mfaEnabled": true,
• "username": "string",
• "password": "string",
• "confirmPassword": "string"

}

Response samples

• 200
• 400
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Validates a password reset link using the provided key

Authorizations:

ApiKeyBearer

query Parameters

key	string <uuid> Unique identifier for the password reset operation

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

key	string <uuid>
mfaEnabled	boolean
username	string or null
password	string or null
confirmPassword	string or null

https://us.thruinc.com/api/Password/validateReset

https://uk.thruinc.com/api/Password/validateReset

https://eu.thruinc.com/api/Password/validateReset

https://au.thruinc.com/api/Password/validateReset

Response samples

• 200
• 400
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Resets a password using the validated password reset link

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Password model containing the key, new password, and confirmation

key	string <uuid>
mfaEnabled	boolean
username	string or null
password	string or null
confirmPassword	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

string

https://us.thruinc.com/api/Password/resetPassword

https://uk.thruinc.com/api/Password/resetPassword

https://eu.thruinc.com/api/Password/resetPassword

https://au.thruinc.com/api/Password/resetPassword

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
• "mfaEnabled": true,
• "username": "string",
• "password": "string",
• "confirmPassword": "string"

}

Response samples

• 200
• 400
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample