SASL-XOAUTH2-TOOL(1)

📦
version 0.27 · 4 versions
, in epel 10, fedora 43

💖 NAME 💖

sasl-xoauth2-tool — bestie, this is the manual page for it, from the Generated Python Manual collection, section 1 of the manual. Yes we're doing man page section 1 energy today. 🎀

✨ SYNOPSIS ✨

sasl-xoauth2-tool [-h] {get-token,test-config,test-token-refresh} ...

okay so it's literally a little command dispatcher: you pick one of get-token, test-config, or test-token-refresh and then it does the thing. that's the whole vibe. 💅

🫶 POSITIONAL ARGUMENTS 🫶

COMMAND 'sasl-xoauth2-tool get-token' 🔑

usage: sasl-xoauth2-tool get-token [-h] --client-id CLIENT_ID
                                   [--tenant TENANT]
                                   [--client-secret CLIENT_SECRET]
                                   [--scope SCOPE] [--use-device-flow]
                                   [--overwrite-existing-token]
                                   {outlook,gmail} [output_file]

Fetches initial access and refresh tokens from an OAuth 2 provider. like, it goes and gets you the tokens, bestie. that's the errand. 🧚

  • {outlook,gmail} — service type. you gotta tell it which one, no guessing.
  • output_file — output file, and '-' for stdout. yes, a literal dash means "just print it at me". 📤

COMMAND 'sasl-xoauth2-tool test-config' 📝

usage: sasl-xoauth2-tool test-config [-h] [--config-file CONFIG_FILE]

Tests a sasl-xoauth2 config file for syntax errors. it's the vibe check for your config. if it's giving broken, this will tell you. 🔍

COMMAND 'sasl-xoauth2-tool test-token-refresh' 🔄

usage: sasl-xoauth2-tool test-token-refresh [-h] [--config-file
CONFIG_FILE]
                                            token_file

Tests that a token can be refreshed (i.e., that the OAuth 2 flow is working correctly). basically: does the refresh actually go through or are we in our flop era 😭

  • token_file — file containing initial access token.

👑 OPTIONS 👑

OPTIONS 'sasl-xoauth2-tool get-token' 💅

  • --client-id CLIENT_ID — required for both services. no client id, no token, periodt.
  • --tenant TENANT — wanted by 'outlook' (defaults to 'consumers'). so if you're on outlook, it's lowkey expecting this one.
  • --client-secret CLIENT_SECRET — required for both services, will prompt the user if blank. leave it empty and it'll ask you nicely 🫶
  • --scope SCOPE — required for 'gmail'. gmail said "you WILL tell me the scope", iconic honestly.
  • --use-device-flow — use simplified device flow for Outlook/Azure. the chill, low-effort route. ✨
  • --overwrite-existing-token — overwrite existing token file (preserves extra fields). so yes it stomps the file, but it's polite about your extra fields, we love that for it. 🌸

OPTIONS 'sasl-xoauth2-tool test-config' 🎀

  • --config-file CONFIG_FILE — config file path (defaults to '/etc/sasl-xoauth2.conf').

OPTIONS 'sasl-xoauth2-tool test-token-refresh' 🌈

  • --config-file CONFIG_FILE — config file path (defaults to '/etc/sasl-xoauth2.conf').
ngl, both of those default to the exact same path, so if you don't pass --config-file you're vibing with '/etc/sasl-xoauth2.conf' whether you meant to or not. 🫡

💜 AUTHOR 💜

Tarick Bedeir tarick@bedeir.com

⭐ DISTRIBUTION ⭐

The latest version of sasl-xoauth2 may be downloaded from https://github.com/tarickb/sasl-xoauth2

and that's the whole page, bestie, we ate and left no crumbs 🍓 this was sasl-xoauth2, dated 2025-08-04, and it's the SASL-XOAUTH2-TOOL(1) page — mwah, go forth and refresh those tokens 💖✨

📦 where this page comes from