Sign users out

Note: This document is written for Okta Classic Engine. If you’re using Okta Identity Engine, see User sign out (local app) for relevant guidance. See Identify your Okta solution (opens new window) to determine your Okta version.

This guide explains an important part of security: minimizing the chances that a malicious actor uses an existing session to perform unauthorized actions. It explains the most common strategies to prevent unauthorized use of a session, which include setting short token lifetimes and allowing users to sign out when they’re done. This guide explains how to sign users out of Okta and your app.

---

Learning outcomes

• How to define a sign-out callback.
• Sign users out of Okta and your app.

What you need

• Okta Developer Edition organization (opens new window)
• An app that can sign in to Okta. To create your own, see the following guides:
  • Sign users in to your web app using the redirect model
  • Sign users into your mobile app using the redirect model
  • Sign users in to your single-page app using the redirect model

Sample code

React Native samples repo (opens new window)

---

About signing users out of an app

Signing users out of an app that is secured using Okta requires that you close the user's session in Okta. In cases where your app also has a session, you also need to close the user's app session.

• Okta Session: Okta maintains a session for the user and stores their information inside an Okta-specific cookie. The next time that a user is redirected to the Okta sign-in page, the user's information is remembered. Sign users out of Okta by clearing the Okta browser session.

• Application Session: Most apps have their own user sessions that you need to close in addition to an Okta user session.

Define the sign-out callback

Signing out of Okta requires the app to open a browser and go to the end session endpoint (opens new window). Okta ends the user's session and immediately redirects the user back to your app. To do this, define a callback route for the sign-out process that matches the post sign-out URL in your Okta app integration settings. If you don't specify a post_logout_redirect_uri, then the browser is redirected to the Okta sign-in page.

1. Open the Admin Console for your org.

2. Go to Applications > Applications to view the current app integrations.

3. Select your app integration.

4. On the General tab, click Edit in the General Settings section.

5. Set a Sign-out redirect URIs section and add a handler for that URI.

   If you'd like to use a custom sign-out flow, skip to sign users out of Okta.

   If you'd like to use the browser sign-out flow, you need to define a callback route.

   Ensure that the endSessionRedirectUri configured at createConfig is the same as one of those defined in the Sign-out redirect URIs section of the Admin Console. For example, if you’re initializing your client with a config file:

   {
     export default {
       oidc: {
         clientId: '${clientId}',
         redirectUri: 'com.okta.example:/login',
         endSessionRedirectUri: 'com.okta.example:/logout',
         discoveryUri: 'https://com.okta.example',
         scopes: ["openid", "profile", "offline_access"],
       }
     };
   }
   

6. Click Save to confirm your changes.

Sign users out of Okta

Sign users out of Okta by ending their session on the Okta authorization server.

Clear the Okta session

Next you should clear the browser session and app session (stored tokens) in memory. An event fires once a user successfully logs out.

Note: This method applies only to the browser sign-in scenario. Use a combination of revokeToken (optional) and clearTokens methods to sign out when using custom sign-in.

Browser sign-in example:

import { signOut } from '@okta/okta-react-native';

signOut();

Custom sign-in example:

import { revokeAccessToken, revokeIdToken, clearTokens } from '@okta/okta-react-native';

await revokeAccessToken(); // optional
await revokeIdToken(); // optional
clearTokens()
    .then(() => { })
    .catch(e => { });

Sign users out of your app

Sign users out of your app by ending their local session. This signs the user out of your app, but doesn't sign the user out of Okta.

The steps required to end the app session vary depending on the type of app that you’re using.

Clear the user's tokens by calling:

import { clearTokens } from '@okta/okta-react-native';

clearTokens()
    .then(() => { })
    .catch(e => { });

Revoke tokens (optional)

Calling clearTokens() discards tokens from the local device storage, but they’re technically still active until they expire. An optional step is to revoke the tokens so they can't be used, even by accident. You can revoke tokens using the following requests:

await revokeAccessToken();

This revokes the access token to make it inactive. Resolves true if the access token has been successfully revoked.

await revokeIdToken();

This revokes the ID token to make it inactive. Resolves true if the ID token has been successfully revoked.

await revokeRefreshToken();

This revokes the refresh token to make it inactive. Resolves true if the refresh token has been successfully revoked.

Access, ID, and refresh tokens must be revoked in separate requests.

See also

Consider configuring self-service registration for your org.

Read more on customizing your org:

• Customize domain and email address
• Style the Okta-hosted Sign-In Widget