PHP Класс Aacotroneo\Saml2\Saml2Auth

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$auth OneLogin_Saml2_Auth
$samlAssertion

Открытые методы

Метод Описание
__construct ( OneLogin_Saml2_Auth $auth )
acs ( ) Process a Saml response (assertion consumer service) When errors are encountered, it returns an array with proper description
getMetadata ( ) : mixed Show metadata about the local sp. Use this to configure your saml2 IDP
getSaml2User ( ) : Saml2User The user info from the assertion
isAuthenticated ( ) : boolean
login ( $returnTo = null ) Initiate a saml2 login flow. It will redirect! Before calling this, check if user is authenticated (here in saml2). That would be true when the assertion was received this request.
logout ( $returnTo = null, $nameId = null, $sessionIndex = null ) Initiate a saml2 logout flow. It will close session on all other SSO services. You should close local session if applicable.
sls ( $retrieveParametersFromServer = false ) Process a Saml response (assertion consumer service) returns an array with errors if it can not logout

Описание методов

__construct() публичный метод

public __construct ( OneLogin_Saml2_Auth $auth )
$auth OneLogin_Saml2_Auth

acs() публичный метод

Process a Saml response (assertion consumer service) When errors are encountered, it returns an array with proper description
public acs ( )

getMetadata() публичный метод

Show metadata about the local sp. Use this to configure your saml2 IDP
public getMetadata ( ) : mixed
Результат mixed xml string representing metadata

getSaml2User() публичный метод

The user info from the assertion
public getSaml2User ( ) : Saml2User
Результат Saml2User

isAuthenticated() публичный метод

public isAuthenticated ( ) : boolean
Результат boolean if a valid user was fetched from the saml assertion this request.

login() публичный метод

Initiate a saml2 login flow. It will redirect! Before calling this, check if user is authenticated (here in saml2). That would be true when the assertion was received this request.
public login ( $returnTo = null )

logout() публичный метод

Initiate a saml2 logout flow. It will close session on all other SSO services. You should close local session if applicable.
public logout ( $returnTo = null, $nameId = null, $sessionIndex = null )

sls() публичный метод

Process a Saml response (assertion consumer service) returns an array with errors if it can not logout
public sls ( $retrieveParametersFromServer = false )

Описание свойств

$auth защищенное свойство

protected OneLogin_Saml2_Auth $auth
Результат OneLogin_Saml2_Auth

$samlAssertion защищенное свойство

protected $samlAssertion