SparQDocs
GuidesAPI referencesparqhq.ai
API referenceSign in

Change Password

POST
/v1/sign-in/change-password

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

The temporary password replaced by the person's own.

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid
Idempotency-Key?string

Makes a retry safe: the same key, route and body within 24 hours returns the stored response and the same result id. The same key with a different body or route is idempotency_conflict; while the first request runs, idempotency_in_progress.

Length8 <= length <= 128

Request Body

application/json
  1. body
challenge*Challenge
Length20 <= length <= 200
new_password*New Password

8 characters to 72 bytes, with an uppercase letter, a digit and a symbol; not the email and not the current password.

Length1 <= length <= 200

Response Body

Successful Response

application/json
  1. response

The step to show next, and the challenge (5 minutes, used once) to send back with it. With choose_workspace, challenge is empty and each choice carries its own.

step*SignInStep
Value in"totp""change_password""enroll_totp""confirm_totp""choose_workspace"
challenge*Challenge
choices?array<>|null
Example Request
curl -X POST 'https://dev-api.silverlyte.io/v1/sign-in/change-password' \  -H 'Content-Type: application/json' \  -d '{  "challenge": "stringstringstringst",  "new_password": "string"}'
Example Response
{  "step": "totp",  "challenge": "string",  "choices": [    {      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",      "workspace_name": "string",      "step": "totp",      "challenge": "string"    }  ]}

Send Message POST

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version. Send a message. The response streams the run as stream events until it ends or pauses.

Check Totp POST

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version. A code from the authenticator, or one recovery code: signed in.