content/kerby/user-guide/2.2-kadmin.mdtext

Title: 2.2 - Kadmin
NavPrev: 2.1-krbclient-apis.html
NavPrevText: 2.1 - KrbClient APIs
NavUp: 2-kerberos-library.html
NavUpText: 2 - Kerberos library
NavNext: 2.3-kdcserver.html
NavNextText: 2.3 - KdcServer
Notice: Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at
    .
    http://www.apache.org/licenses/LICENSE-2.0
    .
    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
	
# 2.2 - Kadmin
Server side admin facilities.



## Local mode
### Initiate a LocalKadminImpl
* Initiate a LocalKadminImpl with prepared KdcConfig and BackendConfig.
<pre>
LocalKadmin kadmin = new LocalKadminImpl(kdcConfig, backendConfig);
</pre>
* Initiate a LocalKadmin with confDir.
<pre>
LocalKadmin kadmin = new LocalKadminImpl(confDir);
</pre>
* Initiate a LocalKadmin with kdcSetting and backend.
<pre>
LocalKadmin kadmin = new LocalKadminImpl(kdcSetting, backend);
</pre>

### Principal operating
* Add principle with principal name.
<pre>
addPrincipal(principal);
</pre>
* Add principle with principal name and password.
<pre>
addPrincipal(principal, password);
</pre>
* Add principle with principal name and kOptions.
<pre>
addPrincipal(principal, kOptions);
</pre>
* Add principle with principal name, password and kOptions.
<pre>
addPrincipal(principal, password kOptions);
</pre>
* Delete principle with principal name.
<pre>
deletePrincipal(principal);
</pre>
* Modify principle with principal name and kOptions.
<pre>
modifyPrincipal(principal, kOptions);
</pre>
* Rename principle.
<pre>
renamePrincipal(oldPrincipalName, newPrincipalName);
</pre>
* Get principle with principal name.
<pre>
getPrincipal(principalName);
</pre>
* Get all the principles.
<pre>
getPrincipals();
</pre>
* Update password with principal name and new password.
<pre>
updatePassword(principal, newPassword);
</pre>
* Export all identity keys to the specified keytab file.
<pre>
exportKeyTab(keyTabFile);
</pre>