Edit Page

res.forbidden()

This method is used to send a 403 ("Forbidden") response back down to the client, indicating that a request is not allowed. This usually means the user agent tried to do something it was not allowed to do, like change the password of another user.

Usage

#
return res.forbidden();

Details

#

Like the other built-in custom response modules, the behavior of this method is customizable.

By default, it works as follows:

Example

#
if ( !req.session.userId ) {
  return res.forbidden();
}

Notes

#
  • This method is terminal, meaning that it is generally the last line of code your app should run for a given request (hence the advisory usage of return throughout these docs).
  • res.forbidden() (like other userland response methods) can be overridden or modified. It runs the response method defined in api/responses/forbidden.js. If a forbidden.js response method does not exist in your app, Sails will use the default behavior.

Is something missing?

If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the sails repo. Once we merge it, the changes will be reflected on the website the next time it is deployed.

Reference

Reference