NAME

Net::SPID::SAML::LogoutResponse

VERSION

version 0.11

SYNOPSIS

    use Net::SPID;
    
    # initialize our SPID object
    my $spid = Net::SPID->new(...);
    
    # generate a LogoutResponse
    my $logoutres = $idp->logoutresponse(
        status          => 'success',
        in_response_to  => $logoutreq->id,
    );
    my $url = $logoutreq->redirect_url;
    
    # parse a LogoutResponse
    my $logutres = $spid->parse_logoutresponse;

ABSTRACT

This class represents a LogoutResponse. You may need to parse such a response in case you initiated a logout procedure on behalf of your user and you're getting the result from the Identity Provider, or you may need to generate a logout response in case the user initiated a logout procedure elsewhere and an Identity Provider is requested logout to you.

CONSTRUCTOR

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

METHODS

xml

This method returns the raw message in XML format (signed).

    my $xml = $logoutreq->xml;

redirect_url

This method returns the full URL of the Identity Provider where user should be redirected in order to continue their Single Logout. In SAML words, this implements the HTTP-Redirect binding.

    my $url = $logoutres->redirect_url;

success

This method parses the status code and returns success, partial or 0.

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