> ## 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.
# Suspend the user flagged by a Praxis Shield incident
> Remediation action. The `scope` body field selects the axis (defaults to `institution`; if omitted, super defaults to `global`). `global` is super-only — it deactivates the account (user.status='inactive'), sets all memberships inactive, and revokes the user's keys/sessions. `institution` sets ONLY the userInstitution memberships tying the user to the incident institutions the caller administers inactive; the account stays active elsewhere and no tokens are revoked. Mounted under the admin gate (isAdmin) and scoped per-institution via the `institutions.edit` entitlement (super bypasses). Cannot suspend a super-admin or yourself.
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json post /api/admin/security/threats/{incidentId}/suspend-user
openapi: 3.0.0
info:
title: Pria Admin API
version: 2.0.1
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/security/threats/{incidentId}/suspend-user:
post:
tags:
- Admin
- Security
summary: Suspend the user flagged by a Praxis Shield incident
description: >
Remediation action. The `scope` body field selects the axis (defaults to
`institution`; if omitted, super defaults to `global`). `global` is
super-only — it deactivates the account (user.status='inactive'), sets
all memberships inactive, and revokes the user's keys/sessions.
`institution` sets ONLY the userInstitution memberships tying the user
to the incident institutions the caller administers inactive; the
account stays active elsewhere and no tokens are revoked. Mounted under
the admin gate (isAdmin) and scoped per-institution via the
`institutions.edit` entitlement (super bypasses). Cannot suspend a
super-admin or yourself.
parameters:
- in: path
name: incidentId
required: true
schema:
type: string
description: Incident id (drives the target user and the institution scope)
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
enum:
- institution
- global
description: >
Suspend axis. `institution` (default) inactivates only the
memberships for the incident institutions the caller
manages. `global` (super-only) deactivates the account +
revokes keys/sessions.
responses:
'200':
description: Suspend applied
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
scope:
type: string
enum:
- global
- institution
suspendedMemberships:
type: integer
userDeactivated:
type: boolean
tokensRevoked:
type: boolean
'400':
description: Invalid incidentId / incident has no user
'403':
description: >
Not authorized, target is super-admin, self-suspend, or `global`
scope requested by a non-super caller
'404':
description: Incident or target user not found
'500':
description: Server error
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````