Revoke Session - Stytch Docs

import { useCallback } from 'react';
import { useStytch } from '@stytch/react';

export const LogOutButton = () => {
const stytch = useStytch();

const logout = useCallback(() => {
  stytch.session.revoke();
}, [stytch]);

return <button onClick={logout}>Log out</button>;
};

{
  "status_code": 200,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141"
}

import { useCallback } from 'react';
import { useStytch } from '@stytch/react';

export const LogOutButton = () => {
const stytch = useStytch();

const logout = useCallback(() => {
  stytch.session.revoke();
}, [stytch]);

return <button onClick={logout}>Log out</button>;
};

{
  "status_code": 200,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141"
}

import { useCallback } from 'react';
import { useStytch } from '@stytch/react';

export const LogOutButton = () => {
const stytch = useStytch();

const logout = useCallback(() => {
  stytch.session.revoke();
}, [stytch]);

return <button onClick={logout}>Log out</button>;
};

{
  "status_code": 200,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141"
}

Wraps the Revoke Session endpoint and revokes the user’s current session. This method should be used to log out a user. While calling this method, we clear the user and session objects from the cache unless the SDK cannot contact the Stytch servers. This behavior can be overriden by using the optional param object.

Parameters

Configuration

object

Additional configuration.

Show properties

forceClear

boolean

default:"false"

When true, clear the user and session object in the cache, even in the event of a network failure revoking the session. When false, the user and session object will not be cleared in the event that the SDK cannot contact the Stytch servers. The user and session object will always be cleared when the session revoke call succeeds.

Response

request_id

string

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

status_code

number

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

⌘I

​Parameters

​Response

Parameters

Response