Red Hat

Getting Started

Get Ready And Fast!!!

How to Get Started ?

This page provides useful information to get you started with PicketLink. We recommend you to follow these steps for a better and speed learning of PicketLink:

  • Download JBoss EAP or WildFly
    PicketLink can be used on both servers. Use the PicketLink Installer to configure them with the latest version of the PicketLink modules and libraries.

  • Get the Quickstarts Up and Running
    This is a very good way to learn from examples. Use your favorite IDE to import the quickstarts and look at their sources. All quickstarts can be deployed on both JBoss EAP and WildFly.

  • Spend Some Time Reading the Available Guides
    Each one cover an important PicketLink aspect. They explain some core concepts and make easier to understand the quickstarts.

  • Read the Reference Documentation
    For more detailed information about a specific aspect of PicketLink.

  • PicketLink JavaDoc Reference
    For more detailed information on JavaDoc for API of PicketLink.

  • Use the User Forum
    And post your questions and feedbacks.


Here we provide some guidance and reference documentation about how you can easily and quickly secure any application using PicketLink.

Some guides are based on the PicketLink Quickstarts , which are very handy to demonstrate most of PicketLink features with some ready-to-use example applications. You can deploy them on both JBoss Enterprise Application Platform 6 or WildFly servers.

Please take a look at the following sections to understand how to get started with PicketLink considering its different aspects and features.

  • Your First PicketLink CDI Application

    This guide will show you how to secure a very simple application using PicketLink. It will cover some core concepts and it will make easier to you understand how those concepts are applied in a project.

  • Single Sign-On Using Security Assertion Markup Language (SAML)

    This guide will show you how to quickly and easily enable your applications to use SAML for Single Sign-On. It will cover some core concepts of SAML and how they are reflected in PicketLink.

  • Identity Management Overview

    This guide will show you how to use the PicketLink Identity Management API to manage identity data (users, roles, groups, credentials, attributes, etc).

  • Custom Identity Model

    This guide will show you how to use the PicketLink Identity Management API to design your own Identity Model.

  • PicketLink Deep Dives by Shane Bryzak

  • Securing Your Applications with PicketLink and DeltaSpike

    If you’re looking for a simple way to secure your Java EE application’s classes and methods, then PicketLink in conjunction with DeltaSpike provides an elegant and flexible solution thanks to DeltaSpike’s support for typesafe security annotations. This powerful combination means you can easily apply security to your application in three simple steps, which we’ll be examining in more detail in this article.

    The objective of these guides is to make you familiar with some core concepts of PicketLink, so you can start applying them to real world usecases. For more details about PicketLink and advanced configuration/usages, please take a look at our documentation.

    Configuring PicketLink Dependencies to Your Project

    If You're Using Apache Maven

    Please, follow the instructions at Maven Dependencies.

    Referencing PicketLink Modules when Using EAP 6 or WildFly

    If you're using JBoss EAP 6 or WildFly you don't need to ship the PicketLink libraries inside your deployment. Instead of that, you can use the META-INF/jboss-deployment-structure.xml file to configure all PicketLink dependencies.

    Please take a look at Referencing PicketLink from JBoss Modules for more details.

    NOTE: Please, consider updating your EAP 6 or WildFly server with the latest PicketLink version using the installer.

    Updating PicketLink Modules in JBoss Enterprise Application Platform 6 and WildFly

    PicketLink libraries are already shipped as modules in both JBoss Enterprise Application Platform 6 and WildFly at:


    In order to provide an easy way to properly update the modules with the latest version, we provide the PicketLink Installer. Basically, it is just a simple Apache Ant script that knows how to get your server installation properly updated with the latest version of PicketLink. So you can always keep the latest features and fixes.

    Check our documentation for more details about the PicketLink Modules in EAP 6 and WildFly.

    Get, Deploy and Run A Lot of Example Applications !

    PicketLink provides a plenty of quickstarts to let you drive quickly to some of the most important features.

    The quickstarts are available in the PicketLink Quickstarts repository.

    Follow the instructions there to get them and deploy in a JBoss Enterprise Application Platform 6 or WildFly server.

    Looking for more Information ?

    The PicketLink documentation is the best source of information about all the PicketLink features and usage.

    The documentation is available here.


    The presentations are available here.

    back to top