> ## Documentation Index
> Fetch the complete documentation index at: https://docs.praxis-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Edit a user (Admin only)
> Edits an existing account; this is the Users edit page. On an existing account, credits, plan, current twin (`institution`, applied together with plan 'sdk'), names, password and MFA change only here; status also changes through the bulk status endpoint and DELETE. Requires users.edit on the account's current twin (on your own twin when the account has none), and on `institution` whenever it names a different twin. Only a super admin can edit a super admin or assign the super role, and a new `accountType` must be user, admin or super. Setting status to 'deleted' deletes the user and needs users.delete.
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json put /api/admin/user/{userId}
openapi: 3.0.0
info:
title: Pria Admin API
version: 2.0.78
description: >-
Pria API Documentation Praxis's developer platform is a core part of our
mission to empower organizations to grow better. Our APIs are designed to
enable teams of any shape or size to build robust integrations that help
them customize and get the most value out of Pria. All Pria APIs are built
using REST conventions and designed to have a predictable URL structure.
They use many standard HTTP features, including methods (POST,
GET, PUT, DELETE) and error response codes.
All API calls are
made under https://hiimpria.ai/api and all responses return standard JSON.
In these docs, you'll find lists of all available endpoints for a given API,
along with interactive code blocks for building requests. For walkthroughs
of basic usage for these APIs, check out the API guides.
servers:
- url: https://pria.praxislxp.com
description: Pria API Server
security: []
tags:
- name: Authentication
description: User authentication, registration, and password management (/api/auth)
- name: OAuth
description: OAuth authentication providers - Google, GitHub, SSO (/api/auth/oauth)
- name: User
description: User profile management and account operations (/api/user)
- name: User Institutions
description: User institution memberships and switching (/api/user/institution)
- name: User Tools
description: Available tools for authenticated users (/api/user/tools)
- name: Institutions
description: Institution settings and configuration (/api/user/institution)
- name: Conversation
description: AI conversation and Q&A endpoints (/api/ai)
- name: Realtime
description: Real-time voice AI and WebRTC sessions (/api/ai/rt)
- name: Assistant
description: AI assistant configuration and management (/api/user/assistant)
- name: History
description: Conversation history and favorites (/api/user/history)
- name: RAG
description: >-
Document upload, embedding, and retrieval-augmented generation
(/api/user/files, /api/user/rag)
- name: Setting
description: Instance variables and settings management (/api/user/setting)
- name: Branding
description: Digital twin branding and customization (/api/agent/branding)
- name: Agent
description: Agent engagement and session management (/api/agent)
- name: SDK Launch
description: >-
SDK launch token signing and verification for secure iframe embedding
(/api/auth/sdk-sign, /api/auth/sdk-verify)
- name: Testing
description: Health checks, diagnostics, and test endpoints (/api/test)
- name: Admin Accounts
description: Account management for super admins (/api/admin/account)
- name: Admin Institutions
description: Institution management for admins (/api/admin/institution)
- name: Admin Users
description: User management for admins (/api/admin/user)
- name: Admin Entitlements
description: >-
User-institution relationships and permissions
(/api/admin/userInstitution)
- name: Admin Sessions
description: Session management for admins (/api/admin/session)
- name: Admin Histories
description: Conversation history management and analytics (/api/admin/history)
- name: Admin Assistants
description: AI assistant management for admins (/api/admin/assistant)
- name: Admin Questions
description: Institution question and prompt management (/api/admin/question)
- name: Admin Tools
description: Tool configuration management (/api/admin/tool)
- name: Admin AI Models
description: AI model configuration (/api/admin/aimodel)
- name: Admin MCP Servers
description: Model Context Protocol server management (/api/admin/mcpserver)
- name: Admin Feedbacks
description: User feedback management (/api/admin/feedback)
- name: Admin Uploads
description: Upload management (/api/admin/upload)
- name: Admin Charts
description: Analytics and visualization chart management (/api/admin/chart)
- name: Admin Memory
description: Admin inspection and editing of user/instance memory parameters.
- name: Admin Usage Limits
description: Per-user usage-vs-cap reporting and account-wide at-limit counts.
paths:
/api/admin/user/{userId}:
put:
tags:
- Admin Users
summary: Edit a user (Admin only)
description: >
Edits an existing account; this is the Users edit page. On an existing
account, credits, plan, current twin (`institution`, applied together
with plan 'sdk'), names, password and MFA change only here; status also
changes through the bulk status endpoint and DELETE. Requires users.edit
on the account's current twin (on your own twin when the account has
none), and on `institution` whenever it names a different twin. Only a
super admin can edit a super admin or assign the super role, and a new
`accountType` must be user, admin or super. Setting status to 'deleted'
deletes the user and needs users.delete.
parameters:
- in: path
name: userId
required: true
schema:
type: string
pattern: ^[0-9a-fA-F]{24}$
description: The user ID to edit
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
fname:
type: string
lname:
type: string
status:
type: string
description: active, inactive or trialing; 'deleted' deletes the user
plan:
type: string
description: >-
sdk places the account on institution; any other plan (free,
entry, premium, pro, monthly) clears its current twin
credits:
type: integer
accountType:
type: string
description: user, admin or super
institution:
type: string
description: Digital twin _id; applied only together with plan 'sdk'
password:
type: string
mustChangePassword:
type: boolean
mfaEnabled:
type: boolean
responses:
'200':
description: User updated
'400':
description: Invalid request, or the users.edit check failed
'403':
description: Only super admins can edit a super admin or assign the super role
'404':
description: User not found
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````