Configuration

You must set a secret token for your application accessing, on October's Backend: Settings > Users > JWTAuth

Usage

Here's the list of available endpoints for this plugin.

If you are using Postman, you can click here to import the collection with all the calls that you need to test it.

Login

POST /api/auth/login

Route name

api.auth.login

Parameters

The field login value can be the account email or username. You can select it on RainLab.User configuration what field should be used for login.

Responses

SUCCESS

Code: 200

{
  token: (string),
  user: (object)
}

ERROR

Code: 401

{
  error: (invalid_credentials|could_not_create_token|user_inactive|user_is_banned)
}

Register

POST /api/auth/register

Route name

api.auth.register

Parameters

The field username can be required. It depends on your RainLab.User configuration. If you sent other fields that your User model have, it will be saved too.

Responses

SUCCESS

Code: 201

[]

ERROR

Code: 401

{
  error: (object|registration_disabled)
}

Supported events

• rainlab.user.beforeRegister
• rainlab.user.register

Account Activation

POST /api/auth/account-activation

Route name

api.auth.account-activation

Parameters

Responses

SUCCESS

Code: 200

[]

ERROR

Code: 422

{
  error: (invalid_activation_code|invalid_user|user_not_found)
}

Forgot Password

POST /api/auth/forgot-password

Route name

api.auth.forgot-password

Parameters

Responses

SUCCESS

Code: 200

[]

ERROR

Code: 404

{
  error: (user_not_found)
}

Reset Password

POST /api/auth/reset-password

Route name

api.auth.reset-password

Parameters

Responses

SUCCESS

Code: 200

[]

ERROR

Code: 422

{
  error: (invalid_reset_password_code|invalid_user|invalid_reset_password_code)
}

Refresh Token

PATCH /api/auth/refresh-token

Middleware

jwt.auth

Route name

auth.api.refresh-token

Responses

SUCCESS

Code: 200

{
  token: (string)
}

ERROR

Code: 403

{
  error: (could_not_refresh_token|given_token_was_blacklisted)
}

Get User

PATCH /api/auth/me

Middleware

jwt.auth

Route name

api.auth.me

Parameters

Responses

SUCCESS

Code: 200

{
  user: (object)
}

ERROR

Code: 404

{
  error: (user_not_found)
}

Known issues

If you are using the API Generator Plugin you could have some issues. So, for now, you can not use them in the same project.

Requests and Bugs

Did I miss anything?

If you need an additional feature or find a bug, please use the product support forum.

From v1.1.* to v1.2.0

Change your routes:

• /api/auth/account_activation is now /api/auth/account-activation
• /api/auth/forgot_password is now /api/auth/forgot-password
• /api/auth/reset_password is now /api/auth/reset-password
• /api/auth/reset_token is now /api/auth/reset-token