Sign users out of your app

Sign users out your application 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 are using.

• Android
• Angular
• ASP.NET
• ASP.NET Core 2.x
• ASP.NET Core 3.x
• iOS
• Node Express
• React
• Spring Boot
• Vue.js

Call the logout method on the authService object. The useOktaAuth React Hook or withOktaAuth higher-order component makes this object easily available within your components.

Function-based component example:

import React from 'react';
import { useOktaAuth } from '@okta/okta-react';

// Basic component with logout button
const Logout = () => {
  const { authService } = useOktaAuth();

  const logout = async () => {
    authService.logout('/');
  };

  return (
    <a onClick={logout}>Logout</a>
  );
};

export default Logout;

Class-based component example:

import React, { Component } from 'react';
import { withOktaAuth } from '@okta/okta-react';

// Basic component with logout button
class Logout extends Component {
  constructor(props) {
    super(props);
    this.logout = this.logout.bind(this);
  }

  async logout() {
    this.props.authService.logout('/');
  }

  render() {
    return (
      <a onClick={this.logout}>Logout</a>
    );
  }
});

// withOktaAuth() makes Okta "authService" object available
// as "this.props.authService"
Logout = withOktaAuth(Logout);
export default Logout;

Next steps