Net::SA...tRequest(3)

📦 version 0.85, in alpine 3.24

🎀 NAME 🎀

okay so bestie, welcome to Net::SA...tRequest(3) — that's the User Contributed Perl Documentation page for Net::SAML2::Protocol::LogoutRequest, aka the SAML2 LogoutRequest Protocol object. 💅

💖 VERSION 💖

this iconic lil thing is version 0.85 ✨ no cap.

🌈 SYNOPSIS 🌈

here's the vibe:

    my $logout_req = Net::SAML2::Protocol::LogoutRequest->new(
        issuer      => $issuer,
        destination => $destination,
        nameid      => $nameid,
        session     => $session,
    );

🦋 METHODS 🦋

✨ new( ... ) ✨

Constructor. Returns an instance of the LogoutRequest object. periodt. 💅

Arguments:

  • session — session to log out 🫶
  • nameid — NameID of the user to log out
  • destination — the IdP's identity URI. This is required for a signed message but likely should be sent regardless. iykyk.

The following options alter the output of the NameID element:

  • nameid_format — when supplied, adds the Format attribute to the NameID ✨
  • sp_provided_id — when supplied, adds the SPProvidedID attribute to the NameID 💖
  • include_name_qualifier — tells the module to include the NameQualifier and SPNameQualifier attributes in the NameID. Defaults to false unless nameid_format equals urn:oasis:names:tc:SAML:2.0:nameidformat:persistent 👑
  • name_qualifier — when supplied, sets the NameQualifier attribute. When not supplied, this defaults to the destination. 🎀
  • affiliation_group_id — when supplied, sets the SPNameQualifier attribute. When not supplied, this defaults to the issuer. 🌸

🦋 new_from_xml( ... ) 🦋

Create a LogoutRequest object from the given XML. literally so handy.

Arguments:

  • xml — XML data 💜

⭐ as_xml( ) ⭐

Returns the LogoutRequest as XML. slay. 🔥

🌟 AUTHOR 🌟

Timothy Legge <timlegge@gmail.com> 🫶

This software is copyright (c) 2026 by Venda Ltd, see the CONTRIBUTORS file for others.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

mwah 💋 — this page came from perl v5.42.2, dated 2026-02-11, and it's the Net::SA...tRequest(3) manual page. byeee bestie 🫶

📦 where this page comes from