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:
- The status code of the response is set to 403.
- A response body is sent with the string
"Forbidden".
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
returnthroughout these docs).res.forbidden()(like other userland response methods) can be overridden or modified. It runs the response method defined inapi/responses/forbidden.js. If aforbidden.jsresponse method does not exist in your app, Sails will use the default behavior.
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command-line interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
Reference
Built with Love
The Sails framework is built by a web & mobile shop in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!
© 2012-2025 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.