NpgsqlRest

Appearance

Comments

LOGOUT ​

Also known as

signout (with or without @ prefix)

Mark endpoint as a sign-out endpoint.

Syntax ​

code
@logout

Logout Endpoint Behavior ​

When an endpoint is marked with logout, NpgsqlRest executes the sign-out operation after running the function.

Void Functions ​

If the function returns void, NpgsqlRest simply:

  1. Executes the function
  2. Signs out of the default authentication scheme
  3. Completes the response

Functions with Return Values ​

If the function returns values, all returned values are interpreted as authentication scheme names to sign out from. This allows selective logout from specific schemes.

  • Single values are added as scheme names
  • Arrays are expanded - each element becomes a scheme name
  • NULL values are ignored
  • If no schemes are returned (empty result), signs out of the default scheme

This is useful when using multiple authentication schemes (e.g., Cookie and Bearer Token) and you want to sign out from only specific ones.

Examples ​

Basic Logout (Void) ​

sql
sql
create function signout()
returns void
language sql
begin atomic;
  -- Optionally perform cleanup
  delete from sessions where user_id = current_user_id();
end;

comment on function signout() is
'HTTP POST
@logout
@authorize';

Equivalent as a SQL file endpoint (sql/signout.sql):

sql
sql
-- HTTP POST
-- @logout
-- @authorize
delete from sessions where user_id = current_user_id();

Signs out of the default authentication scheme.

Logout from Specific Scheme ​

sql
sql
create function logout_cookie()
returns text
language sql
begin atomic;
  select 'Cookies'::text;
end;

comment on function logout_cookie() is
'HTTP POST /auth/logout/cookie
@logout
@authorize';

Signs out only from the "Cookies" authentication scheme.

Logout from Multiple Schemes ​

sql
sql
create function logout_web()
returns text[]
language sql
begin atomic;
  select array['Cookies', 'Bearer']::text[];
end;

comment on function logout_web() is
'HTTP POST /auth/logout/web
@logout
@authorize';

Signs out from both "Cookies" and "Bearer" schemes.

Conditional Scheme Logout ​

sql
sql
create function smart_logout(_scheme text default null)
returns text
language sql
begin atomic;
  select _scheme;  -- NULL signs out of the default scheme, otherwise the named scheme
end;

comment on function smart_logout(text) is
'HTTP POST /auth/logout
@logout
@authorize';
  • POST /auth/logout → Signs out of the default scheme
  • POST /auth/logout with body {"scheme": "Cookies"} → Signs out only from Cookies

Logout with Cleanup ​

sql
sql
create function full_logout()
returns void
language plpgsql
as $$
begin
  -- Revoke all refresh tokens for this user
  delete from refresh_tokens where user_id = current_user_id();

  -- Log the logout event
  insert into audit_log(user_id, action)
  values (current_user_id(), 'logout');
end;
$$;

comment on function full_logout() is
'HTTP POST
@logout
@authorize';

See Also ​

Comments