<!--

  ~ Copyright 2005-2007 WSO2, Inc. (http://wso2.com)
  ~
  ~ Licensed 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.
  -->

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
        "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"/>
        <title>Welcome to WSO2 Identity Server v3.2.0!</title>
        <link href="css/is-docs.css" rel="stylesheet"/>
    </head>
    <body>
        <p>[<a
                href="http://wso2.org/downloads/identity">Download</a>] | [<a
                href="index_docs.html">Documentation Home</a>] | [<a href="release-notes.html">
            Release Note</a>]
        </p>

        <h1>WSO2 Identity Server, v3.2.0 Administrator's Guide</h1>

        <p>This document provides information and instructions on the functionality of the
            Management Console of WSO2 Identity Server.
        </p>

        <p>Your feedback on WSO2 Identity Server is most appreciated. Please send them to our<a
                href="mailinglists.html"> mailing lists</a>.
        </p>

        <h2>Content</h2>

        <div class="toc">
            <ul>
                <li>
                    <a href="#start">Login to Admin Console</a>
                </li>
                <li>
                    <a href="#entitlement">Entitlement</a>
                </li>
                <ul>
                    <li>
                        <a href="#policies">Policies</a>
                    </li>
                </ul>
                <li>
                    <a href="#configure">Configure</a>
                </li>
                <ul>
                    <li>
                        <a href="#usermanagement">User Management</a>
                    </li>
                    <li>
                        <a href="#claimmanagement">Claim Management</a>
                    </li>
                    <li>
                        <a href="#profilemanagement">Profile Management</a>
                    </li>
                    <li>
                        <a href="#keystores">Key Stores</a>
                    </li>
                    <li>
                        <a href="#xkms">XKMS</a>
                    </li>
                    <li>
                        <a href="#logging">Logging</a>
                    </li>
                </ul>
                <li>
                    <a href="#manage">Manage</a>
                </li>
                <ul>
                    <li>
                        <a href="#oauth">OAuth</a>
                    </li>
                    <li>
                        <a href="#cardsissuer">Cards Issuer</a>
                    </li>
                    <li>
                        <a href="#sts">Security Token Service</a>
                    </li>
                    <li>
                        <a href="#shutdown">Shutdown/Restart</a>
                    </li>
                    <li>
                        <a href="#samlsso">SAML SSO</a>
                    </li>
                </ul>
                <li>
                    <a href="#registry">Registry</a>
                </li>
                <ul>
                    <li>
                        <a href="#browse">Browse</a>
                    </li>
                    <li>
                        <a href="#search">Search</a>
                    </li>
                </ul>
                <li>
                    <a href="#monitor">Monitor</a>
                </li>
                <ul>
                    <li>
                        <a href="#statistics">System Statistics</a>
                    </li>
                    <li>
                        <a href="#logs">System Logs</a>
                    </li>
                </ul>
            </ul>
        </div>

        <h2 id="start">Login to Admin Console</h2>
        <p>Download and install Identity Server as in <a href="installation_guide.html">here</a>.
        </p>
        <br/>

        <p>Point your browser to https://host:port/carbon. If you haven't changed the default
            settings then you should be able to login to
            https://localhost:9443/carbon using user name "admin" and password "admin".
        </p>

        <h2 id="entitlement">Entitlement</h2>
        <h3><a name="#policies"></a>Policies
        </h3>
        <p>This allows to define, import and evaluate entitlement policies defined in XACML 2.0. Following feature are supported with this release</p>
		<ul>
		  <li>Create XACML policy using basic or advance policy creation wizards</li>
		  <li>Edit XACML policy using advance UI view or XML view</li>
		  <li>Activate or De-Activate existing XACML policy</li>
		  <li>Import existing XACML policy from file system or from registry</li>
		  <li>Evaluate XACML policies</li>
		  <li>Create basic XACML requests for Evaluation </li>
		  <li>Clear decision cache</li>
		</ul>
        <br/>
        <p>
            <strong>External References:</strong>
        </p>
        <ul>
            <li>
                <a href="http://blog.facilelogin.com/2009/05/identity-server-20-as-xacml-engine.html">
                    Identity Server as an XACML engine
                </a>
            </li>
            <li>
                <a href="http://blog.facilelogin.com/2009/05/adding-fine-grained-authorization-for.html">
                    Adding fine-grained authorization for proxy services in WSO2 ESB
                </a>
            </li>
        </ul>

        <h2 id="configure">Configure Identity Server</h2>
        <h3><a name="usermanagement"></a>User Management
        </h3>
        <p>WSO2 Identity Server works out of the box with the default internal user store.</p>
        <p>Also we can configure Identity Server to work with external user stores via Active
            Directory, LDAP and JDBC.
        </p>
        <br/>
        Please refer
        <a href="user-core/admin_guide.html">User Manager Admin Guide</a>

        <h3><a name="claimmanagement"></a>Claim Management
        </h3>

        <p>The Claim Management component of the Identity Server enables to map a set of attributes
            from the underlying user store to a set of defined claims
        </p>

        <p>The Claim Management component of the WSO2 Carbon enables to map a set of attributes from
            the underlying user store to a set of defined claims
        </p>

        <p>The underlying user store can be either the external user store or the internal user
            store.
        </p>

        <p>A set of claims are identified as a dialect.</p>

        <ul>
            <li>http://wso2.org/claims : Default dialect for WSO2 Carbon</li>
            <li>http://schemas.xmlsoap.org/ws/2005/05/identity : Default dialect for Information
                Cards
            </li>
            <li>http://axschema.org : Default dialect for OpenID Attribute EXchange</li>
            <li>http://schema.openid.net/2007/05/claims : Default dialect for OpenID Simple
                Registration
            </li>
        </ul>

        <h3><a name="profilemanagement"></a>Profile Management
        </h3>

        <p>The Profile Configuration Management component of the Identity Server allows to
            add/modify and delete profile configuration.
            The profile configuration controls how user's empty claim values behave in his profile.
            If a Claim in a user's profile is not given a value explicitly,
            then it is given a value based on the following configuration.
        </p>

        <p>
            <ul>
                <li>Inherited - This means retrieve the value of the corresponding claim in the
                    default profile and use it.
                    This is the default behavior.
                </li>
                <li>Overridden - Leave the empty value as it is, don't try to retrieve it from
                    anywhere else.
                </li>
                <li>Hidden - Hide this claim in the profile.</li>
            </ul>
        </p>

        <h3><a name="keystores"></a>Key Stores
        </h3>
        <p>Key store management manages the keys that are stored in a database. A Key store must
            contain a key pair with a certificate signed by a trusted Certification Authority (CA).
            The WSO2 Carbon uses the JKS type private key called WSO2 Carbon.
        </p>

        <h3><a name="xkms"></a>XKMS
        </h3>
        <p>WSO2 Carbon ships with an in built XKMS trust web service which is being built on top of
            XKMS specification and consists of 5 services which can be used to simplify key
            management
        </p>
        <ul>
            <li>Register service</li>
            <li>Locate service</li>
            <li>Validate service</li>
            <li>Revoke service</li>
            <li>Recover service</li>
            <li>Reissue service</li>
        </ul>

        <h3><a name="logging"></a>Logging
        </h3>
        <p>This shows the existing Log4j configuration.
            And it also allows you to modify existing configuration.
            You can either modify the global Log4j configuration, an Appender or a Logger.
            If you select Persist all Configurations Changes check box, all the modifications will
            be persisted and
            they will be available even after a server restart.
        </p>

        <h2 id="manage">Manage Identity Server</h2>

        <h3><a name="oauth"></a>OAuth
        </h3>
        <p>WSO2 Identity Server supports 2-legged OAuth
        </p>

        <h3><a name="cardsissuer"></a>Cards Issuer
        </h3>
        <p>The Information Cards issuer component of the Identity Server enables to configure cards
            issuer settings
        </p>

        <ul>
            <li><strong>Card Name</strong>: Display name of the downloaded Information Card
            </li>
            <li><strong>Valid Period</strong>: Valid period of an issued card in number of days
            </li>
            <li><strong>Supporting Token Types</strong>: Tokens types being supported
            </li>
            <li><strong>Symmetric binding used</strong>: Specifies whether to use symmetric binding
                or not
            </li>
        </ul>

        <h3><a name="sts"></a>Security Token Service
        </h3>

        <p>The Security Token Service component of the Identity Server to configure the generic STS
            to issue claim based security tokens
        </p>
        <br/>
        <strong>External References:</strong>
        <ul>
            <li>
                <a href="http://blog.facilelogin.com/2009/05/security-token-service-with-wso2.html">
                    Security Token Service with WSO2 Identity Server 2.0.2
                </a>
            </li>
            <li>
                <a href="http://blog.facilelogin.com/2009/06/wso2-identity-server-claim-aware-proxy.html">
                    WSO2 Identity Server + Claim aware proxy services with ESB
                </a>
            </li>
            <li>
                <a href="http://blog.facilelogin.com/2009/06/extending-wso2-identity-server-20-to.html">
                    Extending WSO2 Identity Server 2.0.2 to handle custom SAML assertions
                </a>
            </li>
        </ul>

        <h3><a name="shutdown"></a>Shutdown/Restart
        </h3>

        <p>You can use the Shutdown/Restart feature to shutdown and restart the server.</p>
        <p>The machine can be shutdown gracefully or forcefully.</p>

        <p>The available options are:</p>
        <ul>
            <li>Graceful shutdown</li>
            <li>Forced shutdown</li>
            <li>Graceful Restart</li>
            <li>Immediate Restart</li>
        </ul>

        <h3><a name="samlsso"></a>SAML SSO
        </h3>
        <p>WSO2 Identity Server supports SAML 2.0 based Single Sign-on.
        </p>

        <h2 id="registry">Registry</h2>
        <h3><a name="browse"></a>Browse
        </h3>
        <p>This component can be used to browse the resources stored in the Registry.</p>

        <h3><a name="search"></a>Search
        </h3>
        <p>All resources found in the Registry, can be searched through this interface.
            Search could be refined by optionally providing, resource name, created date range,
            updated date range, tags, comments, property name, property value and the content
        </p>


        <h2 id="monitor">Monitor</h2>
        <h3><a name="statistics"></a>System Statistics
        </h3>
        <p>This shows some statistics related to the WSO2 Data Services instance.
            They include free memory, request count, server name, server start time, system up time,
            active services, total memory,
            average response time, minimum response time and maximum response time.
        </p>

        <h3><a name="logs"></a>System Logs
        </h3>
        <p>This displays all the system logs. You can also search for a particular log using the
            Search Logs feature.
        </p>

    </body>
</html>
