<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Creates a kerberos principal with the given parameters</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.kadm5-chpass-principal.html">kadm5_chpass_principal</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.kadm5-delete-principal.html">kadm5_delete_principal</a></div>
<div class="up"><a href="ref.kadm5.html">KADM5 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.kadm5-create-principal" class="refentry">
<div class="refnamediv">
<h1 class="refname">kadm5_create_principal</h1>
<p class="verinfo">(PECL kadm5 >= 0.2.3)</p><p class="refpurpose"><span class="refname">kadm5_create_principal</span> — <span class="dc-title">Creates a kerberos principal with the given parameters</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.kadm5-create-principal-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>kadm5_create_principal</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$handle</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$principal</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$password</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code></span>
]] )</div>
<p class="para rdfs-comment">
Creates a <em><code class="parameter">principal</code></em> with the given
<em><code class="parameter">password</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.kadm5-create-principal-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">handle</code></em></span>
<dd>
<p class="para">
A KADM5 handle.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">principal</code></em></span>
<dd>
<p class="para">
The principal.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">password</code></em></span>
<dd>
<p class="para">
If <em><code class="parameter">password</code></em> is omitted or is <strong><code>NULL</code></strong>, a random
key will be generated.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">options</code></em></span>
<dd>
<p class="para">
It is possible to specify several optional parameters within the
array <em><code class="parameter">options</code></em>. Allowed are the following options:
<strong><code>KADM5_PRINC_EXPIRE_TIME</code></strong>,
<strong><code>KADM5_PW_EXPIRATION</code></strong>,
<strong><code>KADM5_ATTRIBUTES</code></strong>,
<strong><code>KADM5_MAX_LIFE</code></strong>,
<strong><code>KADM5_KVNO</code></strong>,
<strong><code>KADM5_POLICY</code></strong>,
<strong><code>KADM5_CLEARPOLICY</code></strong>,
<strong><code>KADM5_MAX_RLIFE</code></strong>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.kadm5-create-principal-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.kadm5-create-principal-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-605">
<p><strong>Example #1 Example of principal's creation</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$handle </span><span style="color: #007700">= </span><span style="color: #0000BB">kadm5_init_with_password</span><span style="color: #007700">(</span><span style="color: #DD0000">"afs-1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"GONICUS.LOCAL"</span><span style="color: #007700">, </span><span style="color: #DD0000">"admin/admin"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$attributes </span><span style="color: #007700">= </span><span style="color: #0000BB">KRB5_KDB_REQUIRES_PRE_AUTH </span><span style="color: #007700">| </span><span style="color: #0000BB">KRB5_KDB_DISALLOW_PROXIABLE</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$options </span><span style="color: #007700">= array(</span><span style="color: #0000BB">KADM5_PRINC_EXPIRE_TIME </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">KADM5_POLICY </span><span style="color: #007700">=> </span><span style="color: #DD0000">"default"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">KADM5_ATTRIBUTES </span><span style="color: #007700">=> </span><span style="color: #0000BB">$attributes</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">kadm5_create_principal</span><span style="color: #007700">(</span><span style="color: #0000BB">$handle</span><span style="color: #007700">, </span><span style="color: #DD0000">"burbach@GONICUS.LOCAL"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">, </span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">kadm5_destroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$handle</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.kadm5-create-principal-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.kadm5-modify-principal.html" class="function" rel="rdfs-seeAlso">kadm5_modify_principal()</a> - Modifies a kerberos principal with the given parameters</span></li>
<li class="member"> <span class="function"><a href="function.kadm5-delete-principal.html" class="function" rel="rdfs-seeAlso">kadm5_delete_principal()</a> - Deletes a kerberos principal</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.kadm5-chpass-principal.html">kadm5_chpass_principal</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.kadm5-delete-principal.html">kadm5_delete_principal</a></div>
<div class="up"><a href="ref.kadm5.html">KADM5 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
