forbidden( )


Returns a response with status code 403 (Forbidden) and the information from the options parameter.

The forbidden() function creates a response with the status code 403 (Forbidden).

Optionally, the forbidden() function can take a WixHttpFunctionResponseOptions object which is used to specify the response's body and headers.

Note: If the object contains a status it will be ignored.

Use the forbidden() function to create a response to return from an HTTP function. A 403 (Forbidden) response is used to indicate the request was valid but the server is refusing to process it, usually because the client does not have the necessary permissions for the requested resource.

Method Declaration
Copy
Method Parameters
optionsWixHttpFunctionResponseOptions

The response options.

Returns
Return Type:WixHttpFunctionResponse
Did this help?