---
title: "Set or remove user password"
method: PUT
path: "/api/v1/auth/password"
tags: ["Authentication"]
---

# Set or remove user password

`PUT /api/v1/auth/password`

## Request

- Base URL: `http://miner`
- URL: `http://miner/api/v1/auth/password`
- Auth: none declared
- TypeScript: <https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/docs/api/v1/auth/password/put.ts> (a function with typed inputs; its response is checked against the schema)

Allows a user to set or update their password. To remove the password, set the `password` field to `null`. This operation requires authentication.

## Request body

- SetPasswordRequest: Request for set password action.
  - `password` string, nullable

## Response `204`

Password successfully set or removed.

## Other responses

- `400`: Invalid request payload.
- `401`: Unauthorized. User must be authenticated.
- `500`: Internal server error.

---

[API](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api.md) - [All operations](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/revisions/d341c8e1d506?raw)