Skip to content

Create a new user (admin only)

POST
/users/admin_create

Creates a new user account. Requires admin role. Three modes based on password and SMTP config: (1) password provided — user can sign in immediately, (2) no password + SMTP enabled — sends setup email via Devise, (3) no password + no SMTP — returns a reset URL the admin delivers manually. Skips email confirmation.

Authorizations

tokenAuth

Personal access token authentication. Send via Authorization header: Authorization: Token vulcan_xxx. Tokens are SHA-256 hashed server-side (never stored in plaintext). Scopes: read (GET), write (mutations), admin (everything). Create tokens via Settings → API Tokens in the web UI.

Type
HTTP (token)

Request Body

application/json
JSON
{
  
"user": {
  
  
"name": "Jane Doe",
  
  
"email": "jane.doe@example.org",
  
  
"admin": false,
  
  
"password": "SecureP@ssw0rd2026!"
  
}
}

Responses

User created (response varies by mode)

application/json
JSON
{
  
"toast": {
  
  
"title": "User created.",
  
  
"message": [
  
  
  
"User jane.doe@example.org created with the provided password."
  
  
],
  
  
"variant": "success"
  
},
  
"user": {
  
  
"id": 42,
  
  
"name": "Jane Doe",
  
  
"email": "jane.doe@example.org",
  
  
"admin": false
  
}
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)