1. class
  2. Beartropy
  3. \
  4. Saml2
  5. \
  6. Events
  7. \
  8. Saml2LoginEvent

Saml2LoginEvent

class Saml2LoginEvent

Traits

Dispatchable
InteractsWithSockets
SerializesModels

Methods

__construct(string $idpKey, string $nameId, array $attributes, array $rawAttributes, string|null $sessionIndex = null)

Create a new event instance.

getAttribute(string $key, $default = null)

Get a specific mapped attribute.

getRawAttribute(string $key, $default = null)

Get a specific raw SAML attribute.

array
getAttributes()

Get all mapped attributes.

array
getRawAttributes()

Get all raw SAML attributes.

string|null
getEmail()

Get the email from common attribute sources.

string|null
getName()

Get the name from common attribute sources.

array
toArray()

Get all event data as an array.

Details

at line 22
__construct(string $idpKey, string $nameId, array $attributes, array $rawAttributes, string|null $sessionIndex = null)

Create a new event instance.

Parameters

string $idpKey

The key of the IDP that authenticated the user
string $nameId

The SAML NameID (usually email or unique identifier)
array $attributes

Mapped attributes based on config
array $rawAttributes

Raw SAML attributes as received
string|null $sessionIndex

The SAML session index for SLO

at line 33
getAttribute(string $key, $default = null)

Get a specific mapped attribute.

Parameters

string $key
$default

at line 41
getRawAttribute(string $key, $default = null)

Get a specific raw SAML attribute.

Parameters

string $key
$default

at line 56
array getAttributes()

Get all mapped attributes.

Return Value

array

at line 64
array getRawAttributes()

Get all raw SAML attributes.

Return Value

array

at line 72
string|null getEmail()

Get the email from common attribute sources.

Return Value

string|null

at line 84
string|null getName()

Get the name from common attribute sources.

Return Value

string|null

at line 95
array toArray()

Get all event data as an array.

Return Value

array