Integrate the CyberArk Identity Java SDK

Overview

The CyberArk Identity Java SDK for web apps provides a high-performance framework to help you quickly and easily integrate the CyberArk multi-factor authentication (MFA) services within your web application built on the Java framework. Using the CyberArk Identity SDK, you can incorporate a rich set of authentication factors, such as QR code authentication and push authentication, to provide a seamless and secure end-user experience for your websites.

The CyberArk Identity Java SDK also enables you to provide a rich and seamless authentication and authorization experience to the web app using industry-standard protocols such as OIDC. The SDK also allows user registrations in the web app for secure user onboarding.

The SDK also enables web apps to integrate MFA widgets for secondary or step-up authentication.

The Java angular sample app provides examples of how to leverage CyberArk Identity to help accelerate the development and integration process.

About this section

This section provides resources for integrating the CyberArk Identity Java SDK. The instructions help you leverage the CyberArk MFA platform.

The following topics help you to integrate with the Java SDK and to set up the Java Angular sample app:

In this section:

Before you begin

Before you integrate the CyberArk Identity SDK, make sure you have access to CyberArk Identity tenant.

Install JDK

  1. Download the JDK package from https://www.oracle.com/java and run the file.

  2. Configure the JDK bin path into the system PATH environment variable.

<JDK_Directory>\bin

  1. Use the command below to check the JDK installation version. The minimum version of JDK required is 11.

    java -version

Install Maven

  1. Download the Maven package from https://maven.apache.org/download.cgi.

  2. Configure the bin directory for the Maven directory into the system PATH environment variable.

    <MAVEN_DIRECTORY>\bin

  3. Use the command below to check the Maven installation version. The minimum required version of Maven is 3.5.0.

    mvn –version

For more information, see https://maven.apache.org/install.html.

Integrate the CyberArk Identity Java SDK

You can get the CyberArk Identity Java SDK library from the downloaded GitHub repository.

  1. Add the jar file dependency in your project pom.xml file. 

<dependency>
	<groupId>com.cyberark</groupId>
	<artifactId>identity-sdk-java</artifactId>
	<version>{sdk_version}</version>
</dependency>

  1. Run the command below via command line:

mvn install