SetAuthentication (HttpRequest subroutine): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (match syntax table to syntax template, tags and edits) |
||
| Line 1: | Line 1: | ||
{{Template:HttpRequest:SetAuthentication subtitle}} | {{Template:HttpRequest:SetAuthentication subtitle}} | ||
The <var>SetAuthentication</var> [[Notation conventions for methods#Callable methods|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== | ==Syntax== | ||
{{Template:HttpRequest:SetAuthentication syntax}} | {{Template:HttpRequest:SetAuthentication syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th> | <tr><th>httpRequest</th> | ||
<td> | <td>A previously defined and instantiated <var>HttpRequest</var> object.</td></tr> | ||
</td></tr> | <tr><th>userID</th> | ||
<tr><th> | <td>The user name for the protected area.</td></tr> | ||
<td>The user name for the protected area. | <tr><th>password</th> | ||
</td></tr> | <td>The password for the protected area.</td></tr> | ||
<tr><th> | |||
<td>The password for the protected area. | |||
</td></tr> | |||
<tr><th>realm</th> | <tr><th>realm</th> | ||
<td>The protected area of the site. | <td>The protected area of the site.</td></tr> | ||
</table> | |||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>Once a <var>SetAuthentication</var> method is | <li>Once a <var>SetAuthentication</var> method is issued, the information passed is used to respond to any request to which the server responds with a <code>401 http</code> status code. | ||
issued, the information passed is used to respond to | <li>The most recent <var>SetAuthentication</var> issued is the one that will be in effect. | ||
any request to which the server responds with a <code>401 http</code> | |||
status code. | |||
<li>The most recent <var>SetAuthentication</var> issued is the one | |||
that will be in effect | |||
</ul> | </ul> | ||
==See also== | ==See also== | ||
<ul> | |||
<li>Authentication values created with <var>SetAuthentication</var> are cleared with the <var>[[RemoveAuthentication (HttpRequest subroutine)|RemoveAuthentication]]</var> method. | |||
</ul> | |||
{{Template:HttpRequest:SetAuthentication footer}} | {{Template:HttpRequest:SetAuthentication footer}} | ||
Revision as of 04:48, 19 June 2011
Issue username/password credentials (HttpRequest class)
The SetAuthentication 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
httpRequest:SetAuthentication( userID, password, realm)
Syntax terms
| httpRequest | A previously defined and instantiated HttpRequest object. |
|---|---|
| userID | The user name for the protected area. |
| password | 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.
See also
- Authentication values created with SetAuthentication are cleared with the RemoveAuthentication method.