php-doc-en/reference/kadm5/functions/kadm5-modify-principal.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

129 lines
3.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.kadm5-modify-principal" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>kadm5_modify_principal</refname>
<refpurpose>Modifies a kerberos principal with the given parameters</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>kadm5_modify_principal</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<methodparam><type>string</type><parameter>principal</parameter></methodparam>
<methodparam><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
Modifies a <parameter>principal</parameter> according to the given
<parameter>options</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<listitem>
<para>
A KADM5 handle.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>principal</parameter></term>
<listitem>
<para>
The principal.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
It is possible to specify several optional parameters within the
array <parameter>options</parameter>. Allowed are the following options:
<constant>KADM5_PRINC_EXPIRE_TIME</constant>,
<constant>KADM5_PW_EXPIRATION</constant>,
<constant>KADM5_ATTRIBUTES</constant>,
<constant>KADM5_MAX_LIFE</constant>,
<constant>KADM5_KVNO</constant>,
<constant>KADM5_POLICY</constant>,
<constant>KADM5_CLEARPOLICY</constant>,
<constant>KADM5_MAX_RLIFE</constant>.
<constant>KADM5_FAIL_AUTH_COUNT</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Example of modifying principal</title>
<programlisting role="php">
<![CDATA[
<?php
$handle = kadm5_init_with_password("afs-1", "GONICUS.LOCAL", "admin/admin", "password");
$attributes = KRB5_KDB_REQUIRES_PRE_AUTH;
$options = array(KADM5_PRINC_EXPIRE_TIME => 3451234,
KADM5_POLICY => "gonicus",
KADM5_ATTRIBUTES => $attributes);
kadm5_modify_principal($handle, "burbach@GONICUS.LOCAL", $options);
kadm5_destroy($handle);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>kadm5_create_principal</function></member>
<member><function>kadm5_delete_principal</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->