SetAuthentication (HttpRequest subroutine): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 11: | Line 11: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%httpreq</th> | <tr><th>%httpreq</th> | ||
<td>An instantiated HTTPRequest object. | <td>An instantiated <var>HTTPRequest</var> object. | ||
</td></tr> | </td></tr> | ||
<tr><th>userid</th> | <tr><th>userid</th> | ||
Revision as of 22:42, 15 June 2011
Template:HTTPRequest:SetAuthentication subtitle
This callable method lets you present credentials to a password-protected portion of a website. Such portions of a site are those where the server returns a 401 return code (authentication is required) for a request-for-URL in that portion of the site.
Syntax
Template:HTTPRequest:SetAuthentication syntax
Syntax terms
| %httpreq | An instantiated HTTPRequest object. |
|---|---|
| userid | The user name for the protected area. |
| pw | The password for the protected area. |
| realm | The protected area of the site. |
Usage notes
- Once a SetAuthentication method is
issued, the information passed is used to respond to
any request to which the server responds with a
401 httpstatus code. - The most recent SetAuthentication issued is the one that will be in effect.
- Authentication values created with SetAuthentication are cleared with the RemoveAuthentication method.