SetAuthentication (HttpRequest subroutine): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:HTTPRequest:SetAuthentication subtitle}} | |||
This [[Notation conventions for methods#Callable methods|callable]] method lets you present | This [[Notation conventions for methods#Callable methods|callable]] method lets you present | ||
| Line 8: | Line 7: | ||
request-for-URL in that portion of the site. | request-for-URL in that portion of the site. | ||
==Syntax== | ==Syntax== | ||
{{Template:HTTPRequest:SetAuthentication syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
| Line 37: | Line 34: | ||
with the <var>[[RemoveAuthentication (HTTPRequest subroutine)|RemoveAuthentication]]</var> method. | with the <var>[[RemoveAuthentication (HTTPRequest subroutine)|RemoveAuthentication]]</var> method. | ||
</ul> | </ul> | ||
==See also== | |||
{{Template:HTTPRequest:SetAuthentication footer}} | |||
Revision as of 18:28, 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.