<html>
<head>
<base href="https://wiki.asterisk.org/wiki">
<link rel="stylesheet" href="/wiki/s/en/2171/18/9/_/styles/combined.css?spaceKey=AST&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+10+Application_Authenticate">Asterisk 10 Application_Authenticate</a></h2>
<h4>Page <b>added</b> by <a href="https://wiki.asterisk.org/wiki/display/~wikibot">Wiki Bot</a>
</h4>
<br/>
<div class="notificationGreySide">
<h1><a name="Asterisk10Application_Authenticate-Authenticate%28%29"></a>Authenticate()</h1>
<h3><a name="Asterisk10Application_Authenticate-Synopsis"></a>Synopsis</h3>
<p>Authenticate a user</p>
<h3><a name="Asterisk10Application_Authenticate-Description"></a>Description</h3>
<p>This application asks the caller to enter a given password in order to continue dialplan execution. </p>
<p>If the password begins with the <tt>/</tt> character, it is interpreted as a file which contains a list of valid passwords, listed 1 password per line in the file. </p>
<p>When using a database key, the value associated with the key can be anything. </p>
<p>Users have three attempts to authenticate before the channel is hung up.</p>
<h3><a name="Asterisk10Application_Authenticate-Syntax"></a>Syntax</h3>
<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>Authenticate(password[,options[,maxdigits[,prompt]]])</pre>
</div></div>
<h5><a name="Asterisk10Application_Authenticate-Arguments"></a>Arguments</h5>
<ul>
<li><tt>password</tt> - Password the user should know</li>
<li><tt>options</tt>
<ul>
<li><tt>a</tt> - Set the channels' account code to the password that is entered</li>
<li><tt>d</tt> - Interpret the given path as database key, not a literal file</li>
<li><tt>m</tt> - Interpret the given path as a file which contains a list of account codes and password hashes delimited with <tt>:</tt>, listed one per line in the file. When one of the passwords is matched, the channel will have its account code set to the corresponding account code in the file.</li>
<li><tt>r</tt> - Remove the database key upon successful entry (valid with <tt>d</tt> only)</li>
</ul>
</li>
<li><tt>maxdigits</tt> - maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press the <tt>#</tt> key). Defaults to 0 - no limit - wait for the user press the <tt>#</tt> key.</li>
<li><tt>prompt</tt> - Override the agent-pass prompt file.</li>
</ul>
<h3><a name="Asterisk10Application_Authenticate-SeeAlso"></a>See Also</h3>
<p><a href="/wiki/pages/createpage.action?spaceKey=AST&title=Asterisk+10+Application_VMAuthenticate&linkCreation=true&fromPageId=19005649" class="createlink">Asterisk 10 Application_VMAuthenticate</a><br/>
<a href="/wiki/pages/createpage.action?spaceKey=AST&title=Asterisk+10+Application_DISA&linkCreation=true&fromPageId=19005649" class="createlink">Asterisk 10 Application_DISA</a></p>
<h3><a name="Asterisk10Application_Authenticate-ImportVersion"></a>Import Version</h3>
<p>This documentation was imported from Asterisk version SVN-branch-10-r340810.</p>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://wiki.asterisk.org/wiki/users/removespacenotification.action?spaceKey=AST">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://wiki.asterisk.org/wiki/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+10+Application_Authenticate">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+10+Application_Authenticate?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>