Create a user

post

Authorizations

cookieapi_token

defguard_sessionstringRequired

Body

application/json

emailstringRequired

first_namestringRequired

last_namestringRequired

passwordstring · nullableOptional

phonestring · nullableOptional

usernamestringRequired

Responses

201

User created.

application/json

emailstringRequired

email_mfa_enabledbooleanRequired

enrolledbooleanRequired

first_namestringRequired

groupsstring[]Required

idinteger · int64Required

is_activebooleanRequired

is_adminbooleanRequired

last_namestringRequired

ldap_pass_requires_changebooleanRequired

mfa_enabledbooleanRequired

mfa_methodstring · enumRequiredPossible values:

namestringRequired

phonestring · nullableOptional

totp_enabledbooleanRequired

usernamestringRequired

400

Invalid user data.

401

Session is missing or invalid.

application/json

403

Requires admin privileges.

application/json

500

Unable to create user.

application/json

post/api/v1/user

HTTPcURLJavaScriptPython

POST /api/v1/user HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "email": "[e-mail]",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "[phone]",
  "username": "jdoe"
}

{
  "authorized_apps": [],
  "devices": [],
  "email": "[e-mail]",
  "email_mfa_enabled": false,
  "enrolled": true,
  "first_name": "John",
  "groups": [],
  "id": 3,
  "is_active": true,
  "is_admin": false,
  "last_name": "Doe",
  "ldap_pass_requires_change": false,
  "mfa_enabled": false,
  "mfa_method": "None",
  "name": "John Doe",
  "phone": "[phone]",
  "totp_enabled": false,
  "username": "jdoe"
}