OneLogin_Saml2_LogoutResponse

SAML 2 Logout Response

Methods

Constructs a Logout Response object (Initialize params from settings and if provided load the Logout Response.

__construct(\OneLogin_Saml2_Settings $settings, string|null $response = null)

Arguments

$settings

\OneLogin_Saml2_Settings

Settings.

$response

string|null

An UUEncoded SAML Logout response from the IdP.

Gets the Issuer of the Logout Response.

getIssuer() : string|null

Response

string|null

$issuer The Issuer

Gets the Status of the Logout Response.

getStatus() : string

Response

string

The Status

After execute a validation process, if fails this method returns the cause.

getError() : string

Response

string

Cause

Generates a Logout Response object.

build(string $inResponseTo)

Arguments

$inResponseTo

string

InResponseTo value for the Logout Response.

Returns a Logout Response object.

getResponse() : string

Response

string

Logout Response deflated and base64 encoded

Determines if the SAML LogoutResponse is valid

isValid(string $requestId = null) : bool

throws

Arguments

$requestId

string

The ID of the LogoutRequest sent by this SP to the IdP

Response

bool

Returns if the SAML LogoutResponse is or not valid

Extracts a node from the DOMDocument (Logout Response Menssage)

_query(string $query) : \DOMNodeList

Arguments

$query

string

Xpath Expresion

Response

\DOMNodeList

The queried node

Properties

Object that represents the setting info

_settings : \OneLogin_Saml2_Settings

var

Type(s)

\OneLogin_Saml2_Settings

The decoded, unprocessed XML response provided to the constructor.

_logoutResponse : string

var

Type(s)

string

A DOMDocument class loaded from the SAML LogoutResponse.

document : \DomDocument

var

Type(s)

\DomDocument

After execute a validation process, if it fails, this var contains the cause

_error : string

var

Type(s)

string