User Management System

The User Management System is the central hub of all user-related aspects of an application. It manages and controls users like signing up and signing in users, manage passwords.

User details consist of:

  • email - email address of a user
  • password - password of the account (never returned after it is stored)
  • active - true if the user is active and the account can be used

Sign up user

Register a user to the project.

https://<project-id>.app.jexia.com/ums/signup

The request body should contain the user sign up information:

{
  "email": "myemail@mail.com",
  "password": "my_password"
}
  • 201
    User created successfully. Response contains the full user (except password) including default fields.
  • 400
    Bad request. Request was somehow malformed and was not executed.
  • 409
    User is already registered.
  • 500
    There is an internal error

Fetch a user

Fetch the current user. Authentication should be done with the User Authentication Method before, as the access token is used to get the current user.

GET https://<project-id>.app.jexia.com/ums/user
  • 200
    The user information for the current user.
  • 401
    Invalid authentication. Token not found or invalid.
  • 404
    User not found for the given token.
  • 500
    There is an internal error

Delete user

Delete the current user. The current user is provided by the access token.

DELETE https://<project-id>.app.jexia.com/ums/user

The request body should contain the password of the account (as a security measure):

{
  "password": "my_password"
}
  • 200
    Returns deleted user information
  • 401
    Invalid authentication. Access token was not provided or incorrect.
  • 403
    Forbidden. Password is not correct.
  • 404
    User not found for the given token.
  • 500
    There is an internal error

Change user password

Update the user password for the current user. The current user is found by the access token.

https://<project_id>.app.jexia.com/ums/changepassword

The body should contain the old password (for security reasons) and the new password:

{
  "old_password": "my_old_password",
  "new_password": "my_new_password"
}
  • 200
    User password updated successfully. The response body contains the user object (without the (new) password of course).
  • 400
    Bad request. Possible reasons: - Request has missing fields. - New password is not valid.
  • 401
    Invalid authentication. Token not found or invalid.
  • 403
    Forbidden. Old password is not correct.
  • 404
    User not found for the given token.