edubase_post_user
Create a new EduBase user account with username, name, email, and optional settings. Generates a random initial password when none is provided and returns account credentials.
Instructions
Create a new EduBase user account with a username, name, email address and optional details (group, language, timezone, custom fields, etc.). A random initial password is generated if none is given. Returns the user identification string, and the username and password for non-exam accounts.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| exam | No | user is only allowed to login when accessing exams (default: false) | |
| color | No | desired favorite color (default/branding/red/blue/yellow/green/purple/gray) (default: default) | |
| Yes | valid email address | ||
| group | No | name of the user group | |
| phone | No | valid phone number in format "+prefix number" without special characters | |
| custom | No | custom field data, keyed by field name (sent as `custom_{field}`), only if the specified field is configured for the target EduBase instance | |
| gender | No | gender ("male", "female", or "other") | |
| notify | No | notify user via email (or SMS) (default: false) | |
| language | No | desired account language (default: API application owner's language) | |
| password | No | password (4-64 characters) (default: initial random password is automatically generated) | |
| template | No | a template ID for the new account (default: none) | |
| timezone | No | desired timezone (default: API application owner's timezone) | |
| username | Yes | username (4-64 characters) | |
| birthdate | No | date of birth | |
| full_name | No | override automatic full name (1-255 characters) | |
| last_name | Yes | last name (1-64 characters) | |
| first_name | Yes | first name (1-64 characters) | |
| display_name | No | override automatic display name (1-255 characters) | |
| must_change_password | No | user is forced to change password on first login (default: false) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user | Yes | ||
| password | No | ||
| username | No |