Skip to main content
PUT
Edit a user (Admin only)

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

userId
string
required

The user ID to edit

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
email
string<email>
fname
string
lname
string
status
string

active, inactive or trialing; 'deleted' deletes the user

plan
string

sdk places the account on institution; any other plan (free, entry, premium, pro, monthly) clears its current twin. A plan change you are not allowed to make is ignored

credits
integer

Ignored when you are not allowed to change credits

accountType
string

user, admin or super

institution
string

Digital twin _id; applied only together with plan 'sdk'

password
string
mustChangePassword
boolean
updatePasswordOnSSO
boolean
passwordChangeSkipOnSSO
boolean

Default true: SSO sign-ins skip the forced password change

mfaEnabled
boolean

true asks this person for an emailed code at every sign-in from a device that is not trusted (an authenticator app they already use keeps working); false turns multi-factor authentication off, clears their authenticator app and backup codes, and signs out their trusted devices. Anything other than true or false is refused with 400.

ragLimitChunks
integer

How many knowledge segments a turn retrieves when this person works in their personal space, without a Digital Twin (default 2; rounded and clamped to 1-15)

Required range: 1 <= x <= 15
personalWelcomePending
boolean

true shows the welcome message the next time this person opens their personal Pria, while they belong to no Digital Twin; false clears it

ragKagMode
boolean

The person's retrieval mode: false = RAG Only, true = RAG + KAG Fusion; missing means RAG + KAG Fusion wherever knowledge-graph retrieval (KAG) is available. Send it only when the mode is changed: saving it records when the choice was made (ragKagModeChosenAt; a value in the body is ignored), and only a recorded false keeps KAG off

Response

User updated