On This Page
Sign users in to your web application
This guide explains how to use Okta as the user store for your server-side web application and sign users in to your application.
Note: If you are building a single-page (browser) app, see Sign users in to your single-page application instead. Or, if you are building a server that returns API responses (but not HTML), see Protect your API endpoints.
- Create an Okta app integration to represent your app in your org.
- Add dependencies and configure your app to use Okta for authentication.
- Sign a user in to your app
What you need
- Okta Developer Edition organization (opens new window)
- Knowledge of building server-side Web applications
- A project or application to add authentication to.
With browser-based apps, the risk of the refresh token being compromised is high when a persistent refresh token is used. This threat is greatly reduced by rotating refresh tokens. Refresh token rotation helps a public client to securely rotate refresh tokens after each use. A new refresh token is returned each time the client makes a request to exchange a refresh token for a new access token. Refresh token rotation works with SPAs, native apps, and web apps in Okta.
See the OAuth 2.0 for Browser-Based Apps specification (opens new window) for the latest spec information on using refresh tokens with browser-based apps.
To sign users in, your application redirects the browser to an Okta-hosted sign-in page. Okta then redirects back to your application with information about the user. You can learn more about how this works on Okta-hosted flows.
Your web application must host a route that Okta sends information to when a user signs in. This route is called a callback route or redirect URI.
The callback route is not seen by the user, and it's not the user's final destination. It's just one step in the authentication redirect flow.
Our examples use
/authorization-code/callback as a default route path, but you can change this. The route path is used in the next step.
Before you can sign a user in, you need to create an Okta app integration that represents your web application.
Sign in to your Okta organization with your administrator account.
In the Admin Console, go to Applications > Applications.
Click Create App Integration.
Select OIDC - OpenID Connect as the Sign-in method.
Select Web Application as the Application type and click Next.
Note: It is important to choose the appropriate application type for apps that are public clients. Failing to do so may result in Okta API endpoints attempting to verify an app's client secret, which public clients aren't designed to have, and would break the sign-in or sign-out flow.
Enter a name for your app integration (or leave the default value).
Enter values for the Sign-in redirect URIs. This is the callback described in Understand the callback route. Add values for local development (for example,
http://localhost:8080/authorization-code/callback) and production (for example,
If your OpenID Connect client has multiple redirect URIs and you want to use a single redirect URI with a wildcard for the subdomain, select the Allow wildcard * in sign-in redirect URI checkbox.
Caution: The use of wildcard subdomains is discouraged as an insecure practice, since it may allow malicious actors to have tokens or authorization codes sent to unexpected or attacker-controlled pages. Exercise caution if you decide to include a wildcard redirect URI in your configuration.
See the parameter Details section on the Apps API Reference page for configuration guidance on the use of wildcard subdomains.
Add the Base URI of your application during local development, such as
http://localhost:3000. Also, add any base URIs where your application runs in production, such as
Assign the group that you want (if you set Group Assignments for your app) or leave the Everyone default. See the Assign app integrations (opens new window) topic in the Okta product documentation for instructions on how to assign the app integration to individual users and groups.
Click Save to finish creating the Okta app integration.
On the General tab, the Client Credentials section shows the client ID and client secret values for your app integration.
Copy the Client ID and Client secret values using the Copy to Clipboard button beside each text field. You need to copy some values into your application later, so leave your Admin Console open.
In the General Settings section, click Edit and scroll down to Login. Include a URI in the Initiate login URI box to have Okta initiate the sign-in flow. When Okta redirects to this endpoint (for example,
https://example.com/login), the client is triggered to send an authorize request. This URI is also used when users reset their passwords while signing in to the app. Okta redirects the user back to this URI after the password is reset so that the user can continue to sign in.
You can choose to get a refresh token along with the access token and/or ID token.
The default refresh token behavior is Use persistent token for web apps.
To enable refresh token rotation in your app integration, do the following:
- Open the web app integration that you just created and select the General tab.
- Scroll to the General Settings panel, and click Edit.
- In the Allowed grant types, select Refresh Token.
- In the Refresh Token section, select Rotate token after every use.
Note: The default number of seconds for the Grace period for token rotation is set to 30 seconds. You can change the value to any number between 0 and 60 seconds. After the refresh token is rotated, the previous token remains valid for this amount of time to allow clients to get the new token. Using a value of 0 indicates that there is no grace period.
XMLHttpRequest to the Okta API with the Okta session cookie. For instructions on setting trusted origins, see Grant cross-origin access to websites.
Note: You should only grant access to specific origins (websites) that you control and trust to access the Okta API.
Next you need to add an Okta SDK to your application.
You need the following values from the Okta Application and the Admin Console that you worked with in Create an Okta application:
- Client ID — find it in the applications list or on the application's General tab.
- Client Secret — find it on the application's General tab.
- Okta Domain — you can find the Okta Domain in the Admin Console's global header in the upper-right corner of the page. Click the section that displays your email and company name. A drop-down box appears and displays general org information including the full Okta domain (for example, subdomain.okta.com).
You can use the default Custom Authorization Server that's provided in your Okta Developer Edition (opens new window) org. If you want to use another Custom Authorization Server, then you need the following value from the Admin Console:
- Authorization Server ID — find it on the Security > API > your custom Authorization Server name > Settings tab. The Authorization Server ID is the last generated ID string from the Issuer property. For example, if the issuer is
https://dev-000000.okta.com/oauth2/auss5kkzkkzYune155e6, then your Authorization Server ID is
Note: Okta's Developer Edition makes most key developer features available by default for testing purposes. Okta's API Access Management product — a requirement to use Custom Authorization Servers — is an optional add-on in production environments.
You can configure the properties of your application with configuration files, environment variables, or other framework specific techniques.
To sign a user in, your application must redirect the browser to the Okta-hosted sign-in page. You can do this when a user visits a protected route or when the user clicks a button to sign in.
The user is redirected to the hosted sign-in page where they authenticate. After successful authentication, the browser is redirected back to your application along with information about the user.
Note: To customize the hosted sign-in page, see Style the Okta-hosted Sign-In Widget.
You can also define protected routes or areas of your application that will always require authentication.
In many applications, you want to prevent the user from accessing certain routes or sections unless they are signed in. You can require authentication across the entire app or just require it for particular routes or controllers. Any route that doesn't specifically require authentication is accessible without signing in (also called anonymous access).
If you want the user to only have access to a route if they are signed in, require authentication for just those routes.
For some applications, you may want to require the user to be authenticated for all routes.
When a user signs in, their profile information (stored in Okta) is made available to your application. It's common to use this info to update your application's UI.
By default, the profile items (called "claims") that Okta returns include the user's email address, name, and preferred username.
You should now understand how to sign users in to your web applications using Okta.