Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Rubick65/calenderyBack/llms.txt

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

These endpoints handle the complete onboarding flow: a caller submits registration details, receives a verification email, confirms via the emailed token, and can later validate or re-trigger the verification process.

Register a new user

Creates a new user record and publishes an OnRegistrationCompleteEvent that dispatches a verification email to the provided address. The account is created with enable = false until the email token is confirmed.

Request body

idUsuario
number
Optional. Numeric user ID — omit on creation; the server assigns the ID.
nombre
string
required
Display name. Must not be blank.
email
string
required
Valid email address. Validated with @ValidEmail. Must not be blank.
descripcion
string
Short bio or description. Maximum 200 characters.
keypass
string
required
Password / passphrase for the account. Must not be blank.
fotoPerfil
string
URL of the user’s profile photo. Can be updated later via the signed-URL upload flow.
clavePublica
string
The user’s E2E encryption public key. Can be set or updated later via PUT /api/users/app/publicKey.

Response 200 OK

idUsuario
number
Newly assigned numeric user ID.
roles
string[]
List of role names assigned to the user (e.g. ["ROLE_USER"]).
curl -X POST https://api.example.com/api/users/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "nombre": "Alice",
    "email": "alice@example.com",
    "keypass": "s3cr3tP@ss",
    "descripcion": "Hello, I am Alice!"
  }'
Response
{
  "idUsuario": 42,
  "roles": ["ROLE_USER"]
}

Confirm email registration token

Activates the user account by validating the one-time token included in the verification email. On success, user.enable is set to true.

Query parameters

token
string
required
The verification token from the registration email.

Response

StatusMeaning
200 OKAccount activated. Empty body.
401 UnauthorizedToken has expired (ExpiredVerificationTokenException).
404 Not FoundToken does not exist (TokenNotFoundException).
curl "https://api.example.com/api/users/registrationConfirm?token=abc123-def456"

Log in

Authenticates the caller using HTTP Basic credentials (email + password). On success, returns the user’s ID and assigned roles. The Authorization header must contain Basic <base64(email:password)>.

Response 200 OK

idUsuario
number
The authenticated user’s numeric ID.
roles
string[]
List of role names (e.g. ["ROLE_USER"]).
curl -X POST https://api.example.com/api/users/auth/login \
  -u "alice@example.com:s3cr3tP@ss"
Response
{
  "idUsuario": 42,
  "roles": ["ROLE_USER"]
}

Validate user account status

Returns a combined object containing the user’s identity and a boolean indicating whether their account is currently enabled. Useful before prompting a user to re-send a verification email.

Query parameters

email
string
required
The email address of the user to validate.

Response 200 OK

userInfo
object
Embedded UserInfoResponseDto.
enable
boolean
true if the account has been activated via the email verification flow; false otherwise.
curl "https://api.example.com/api/users/auth/validateUser?email=alice@example.com"
Response
{
  "userInfo": {
    "idUsuario": 42,
    "roles": ["ROLE_USER"]
  },
  "enable": false
}

Confirm account is active

Checks that the specified user’s account is currently enabled and throws an error if it is not. Requires ROLE_USER and ownership (#idUsuario == authentication.principal.idUsuario). Typically called after login to gate access to protected app features.

Query parameters

idUsuario
number
required
Numeric ID of the user to check. Must match the authenticated principal.

Response

StatusMeaning
200 OKAccount is active. Empty body.
403 ForbiddenidUsuario does not match the authenticated user.
curl "https://api.example.com/api/users/activeAccountConfirmation?idUsuario=42" \
  -u "alice@example.com:s3cr3tP@ss"

Resend registration verification token

Triggers a new verification email for the given user ID. Useful when the original token has expired or was never received.

Query parameters

idUsuario
number
required
The numeric ID of the user who needs a new token.

Response

StatusMeaning
204 No ContentNew verification email dispatched. Empty body.
curl "https://api.example.com/api/users/auth/resendRegistrationToken?idUsuario=42"

Build docs developers (and LLMs) love