Okta Spring Boot Sample

This example shows you how to use the Okta Spring Boot Starter to login a user. The login is achieved through the Authorization Code Flow where the user is redirected to the Okta-Hosted login page. After the user authenticates, they are redirected back to the application and a local cookie session is created.

It also shows how to return the user's information from an API using an OAuth 2.0 access token.

Prerequisites

Before running this sample, you will need the following:

• Java 17+
• An Okta Integrator Free Plan account. To get one, sign up for an Integrator account. Once you have an account, sign in to your Integrator account. Next, in the Admin Console:

1. Go to Applications > Applications
2. Click Create App Integration
3. Select OIDC - OpenID Connect as the sign-in method
4. Select Web Application as the application type, then click Next
5. Enter an app integration name
6. Configure the redirect URIs:

• Accept the default redirect URI values:
• Sign-in redirect URIs: http://localhost:8080/login/oauth2/code/okta
• Sign-out redirect URIs: http://localhost:8080

7. In the Controlled access section, select the appropriate access level
8. Click Save

Creating an OIDC Web App manually in the Admin Console configures your Okta Org with the application settings. You may also need to configure trusted origins for http://localhost:8080 in Security > API > Trusted Origins.

Get the Code

git clone https://github.com/okta-samples/okta-spring-boot-sample.git
cd okta-spring-boot-sample

Update your config file at .okta.env with the values from your application's configuration:

ISSUER=https://dev-133337.okta.com
CLIENT_ID=0oab8eb55Kb9jdMIr5d6
CLIENT_SECRET=NEVER-SHOW-SECRETS

Where are my new app's credentials?

After creating the app, you can find the configuration details on the app’s General tab:

• Client ID: Found in the Client Credentials section
• Client Secret: Click Show in the Client Credentials section to reveal
• Issuer: Found in the Issuer URI field for the authorization server that appears by selecting Security > API from the navigation pane.

Enable Refresh Token

Manually enable Refresh Token on your Okta application to avoid third-party cookies. Sign in to your Okta Developer Edition account. Press the Admin Console button to navigate to the Okta Admin Console. In the sidenav, navigate to Applications > Applications and find the Okta application for this project named okta-spring-boot-sample. Edit the application's General Setting to enable the Refresh Token checkbox. Save your changes.

Run the Example

./mvnw spring-boot:run

Log in at http://localhost:8080.

API Access with OAuth 2.0

You can also retrieve user information from the /hello endpoint with an OAuth 2.0 access token.

First, you'll need to generate an access token.

1. Run okta apps create spa. Set oidcdebugger as an app name and press Enter.

2. Use https://oidcdebugger.com/debug for the Redirect URI and set the Logout Redirect URI to https://oidcdebugger.com.

3. Navigate to the OpenID Connect Debugger website.

   1. Fill in your client ID
   2. Use https://{yourOktaDomain}/oauth2/default/v1/authorize for the Authorize URI
   3. Select code for the response type and Use PKCE
   4. Click Send Request to continue

4. Set the access token as a TOKEN environment variable in a terminal window.

   TOKEN=eyJraWQiOiJYa2pXdjMzTDRBYU1ZSzNGM...
   

5. Test the API with HTTPie and an access token.

   http :8080/hello Authorization:"Bearer $TOKEN"
   

Learn More

For more details on how to build an application with Okta and Spring Boot / Spring Security you can read A Quick Guide to Spring Boot Login Options.