SoulFire LogoSoulFire

Update user

Updates an existing user's profile information.

PATCH
/v1/users/:id

Updates an existing user's profile information.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Path Parameters

id*string

The unique identifier (UUID) of the user to update. Cannot be the ID of the requesting user (cannot update self via this method). Cannot be the root user ID (00000000-0000-0000-0000-000000000000).

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

username*string

The new username for the user. Must be lowercase, between 3 and 32 characters. Must begin with an alphanumeric character, followed by alphanumeric characters or dashes, and end with an alphanumeric character. Must be unique across all users.

role*

The new role to assign to the user. ADMIN users have all permissions, while USER role has limited permissions.

email*string

The new email address for the user. Must be a valid email format and unique across all users. Maximum length is 255 characters.

Formatemail

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://127.0.0.1:38765/v1/users/:id" \  -H "Content-Type: application/json" \  -d '{    "username": "string",    "role": {},    "email": "user@example.com"  }'
{}

How is this page?

Get user GET

Retrieves detailed information about a specific user.

Delete user DELETE

Deletes an existing user from the system.