NAME

Net::SPID::SAML::In::LogoutRequest

VERSION

version 0.15

SYNOPSIS

    use Net::SPID;
    
    # initialize our SPID object
    my $spid = Net::SPID->new(...);
    
    # parse a LogoutRequest
    my $logoutreq = $spid->parse_logoutrequest($payload, $url);

ABSTRACT

This class represents an incoming LogoutRequest. You can use this to parse a logout request in case the user initiated a logout procedure elsewhere and an Identity Provider is requesting logout to you.

CONSTRUCTOR

This class is not supposed to be instantiated directly. You can get one by calling "parse_logoutrequest" in Net::SPID::SAML.

METHODS

xml

This method returns the raw message in XML format.

    my $xml = $logoutreq->xml;

validate

This method performs validation of the incoming message according to the SPID rules. In case of success it returns a true value; in case of failure it will die with the relevant error.

    eval { $logoutreq->validate };
    if ($@) {
        warn "Bad LogoutRequest: $@";
    }

make_response

This is a shortcut for "logoutresponse" in Net::SPID::SAML::IdP. See its documentation for the required parameters (in_response_to is automatically supplied).

    my $logoutres = $logoutreq->make_response(
        status => 'success',
    );

AUTHOR

Alessandro Ranellucci <aar@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018 by Alessandro Ranellucci.

This is free software, licensed under:

  The (three-clause) BSD License