Documentation Index

Fetch the complete documentation index at: https://support.fortanix.com/llms.txt

Use this file to discover all available pages before exploring further.

Create a new user with the given properties.

  • Published on Jul 13, 2026
  • 1 minute(s) read
Prev Next
Post
/sys/v1/users

Create a new user with the given properties.

Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization

Please enter your token prefixed with 'Basic ' (e.g., 'Basic your_token_here')

Body parameters
object
user_email
string (email) Required
user_password
string Required
recaptcha_response
string | null
first_name
string | null
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
last_name
string | null
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
Responses
2XX

Success result

Expand All
object
account_role
Array

User's role(s) and state in an account.

User account flag or legacy user account role name or custom role id

OneOf
string
string
Valid values[ "STATEENABLED", "PENDINGINVITE" ]
string
string
Valid values[ "ACCOUNTADMINISTRATOR", "ACCOUNTMEMBER", "ACCOUNTAUDITOR" ]
string (uuid)
string
created_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
dependent_services
Array of string | null
string
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
description
string | null
email_verified
boolean | null
explicit_groups
object | null

Explicit group assignments.

This is similar to groups field except that it does not include groups due to all-groups roles. Use this field to find out which group assignments can be changed using mod_groups and del_groups fields in user update API.

property*
Array additionalProperties

User's role(s) in a group.

Legacy user group role name or custom role id

OneOf
string
string
Valid values[ "GROUPAUDITOR", "GROUPADMINISTRATOR" ]
string (uuid)
string
first_name
string | null
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
groups
object | null
property*
Array additionalProperties

User's role(s) in a group.

Legacy user group role name or custom role id

OneOf
string
string
Valid values[ "GROUPAUDITOR", "GROUPADMINISTRATOR" ]
string (uuid)
string
has_account
boolean | null
has_password
boolean | null
last_logged_in_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
last_name
string | null
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
mfa_devices
Array of object (MfaDevice)

Mfa devices registered with the user

object
name
string

Name given to the FIDO device.

Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
type
string

Type of MFA device

Valid values[ "U2f", "Fido2" ]
origin
string | null

Origin of the FIDO device.

new_email
string (email)
self_provisioned
boolean | null
u2f_devices
Array of object (MfaDevice)
object
name
string

Name given to the FIDO device.

Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
type
string

Type of MFA device

Valid values[ "U2f", "Fido2" ]
origin
string | null

Origin of the FIDO device.

user_email
string (email)
user_id
string (uuid)