latestOpenAPI 3.0.32026-08-10234358.4 KB

3d5d69795558

Users

Create a user

Create a new user in the system

post/user-service/users

Request body

namestring required

User's name

type'USER' | 'SA' required

User type - either regular USER or Service Account (SA)

emailstring email

User's email address (required for type 'user', optional for type 'SA')

descriptionstring nullable

User's description or bio (optional, commonly used for SA)

role_idsstring[]

List of role IDs to assign to the user

team_idsstring[]

List of team IDs to add the user to

profile_photostring uri nullable

URL to user's profile photo

created_bystring email nullable

Email address of the person creating this user (will be looked up in the database)

onboarding_userboolean

If true, automatically assigns the 'Admin' role (from account_id=null) to the user

is_ssoboolean

If true, skips Auth0 user creation and password reset email. Use this flag for SSO users managed externally.

Response

Created user

idstring uuid required

Unique identifier for the user

account_idstring required

Account identifier this user belongs to

namestring required

User's full name

emailstring email nullable

User's email address

descriptionstring nullable

User's description or bio

profile_photostring uri nullable

URL to user's profile photo

created_atstring date-time required

When the user was created

last_loginstring date-time nullable

User's last login time

email_verifiedboolean

Whether the user's email has been verified

assigned_role_idsstring[]

List of role IDs directly assigned to this user

team_idsstring[]

List of team IDs this user belongs to

connectionstring nullable

Connection/authentication provider used by the user

created_bystring uuid nullable

User ID of the person who created this user

created_by_namestring nullable

Name of the user who created this user

system_generatedboolean

Whether this service account was automatically created by the system during migrations or other automated processes

type'USER' | 'SA'

User type - either regular USER or Service Account (SA)