Index | Saml2 API

A

AdminController — Class in namespace Beartropy\Saml2\Http\Controllers
Saml2Controller::acs() — Method in class Saml2Controller: Assertion Consumer Service - process SAML response.
Saml2Controller::acsAuto() — Method in class Saml2Controller: Generic Assertion Consumer Service - auto-detect IDP from SAML response.
IdpRequest::authorize() — Method in class IdpRequest
IdpResolver::all() — Method in class IdpResolver: Get all available IDPs.

B

Saml2::buildSettings() — Method in class Saml2
Saml2Idp::booted() — Method in class Saml2Idp: Prevent key from being changed after creation.
Saml2ServiceProvider::boot() — Method in class Saml2ServiceProvider: Bootstrap any application services.
Saml2Service::buildSettings() — Method in class Saml2Service: Build onelogin/php-saml settings array for an IDP.

C

CreateIdpCommand — Class in namespace Beartropy\Saml2\Console\Commands
CreateIdpCommand::createFromUrl() — Method in class CreateIdpCommand
CreateIdpCommand::createFromFile() — Method in class CreateIdpCommand
CreateIdpCommand::createInteractive() — Method in class CreateIdpCommand
TestIdpCommand::checkField() — Method in class TestIdpCommand
AdminController::createIdp() — Method in class AdminController: Show create IDP form.
$ Saml2Idp#casts — Property in class Saml2Idp: The attributes that should be cast.
IdpResolver::clearCache() — Method in class IdpResolver: Clear cached IDP data.
CertificateHelper — Class in namespace Beartropy\Saml2\Support
CertificateHelper::clean() — Method in class CertificateHelper: Clean certificate string by removing headers and whitespace.

D

$ CreateIdpCommand#description — Property in class CreateIdpCommand
DeleteIdpCommand — Class in namespace Beartropy\Saml2\Console\Commands
$ DeleteIdpCommand#description — Property in class DeleteIdpCommand
$ GenerateSpCertCommand#description — Property in class GenerateSpCertCommand
$ ListIdpsCommand#description — Property in class ListIdpsCommand
$ PublishListenerCommand#description — Property in class PublishListenerCommand
$ RefreshIdpMetadataCommand#description — Property in class RefreshIdpMetadataCommand
$ ResetSetupCommand#description — Property in class ResetSetupCommand
$ TestIdpCommand#description — Property in class TestIdpCommand
AdminController::deleteIdp() — Method in class AdminController: Delete IDP.

E

CreateIdpCommand::extractName() — Method in class CreateIdpCommand
AdminController::editIdp() — Method in class AdminController: Show edit IDP form.
AdminController::editMapping() — Method in class AdminController: Show attribute mapping editor.
IdpResolver::exists() — Method in class IdpResolver: Check if an IDP exists by key.
Saml2Service::extractIssuerFromResponse() — Method in class Saml2Service: Extract the Issuer element from a SAML response XML.

F

SetupController::fetchFromUrl() — Method in class SetupController: Fetch metadata from URL server-side (proxy for CORS issues).
$ Saml2Idp#fillable — Property in class Saml2Idp: The attributes that are mass assignable.
$ Saml2Setting#fillable — Property in class Saml2Setting: The attributes that are mass assignable.

G

CreateIdpCommand::generateKey() — Method in class CreateIdpCommand
GenerateSpCertCommand — Class in namespace Beartropy\Saml2\Console\Commands
Saml2LoginEvent::getAttribute() — Method in class Saml2LoginEvent: Get a specific mapped attribute.
Saml2LoginEvent::getRawAttribute() — Method in class Saml2LoginEvent: Get a specific raw SAML attribute.
Saml2LoginEvent::getAttributes() — Method in class Saml2LoginEvent: Get all mapped attributes.
Saml2LoginEvent::getRawAttributes() — Method in class Saml2LoginEvent: Get all raw SAML attributes.
Saml2LoginEvent::getEmail() — Method in class Saml2LoginEvent: Get the email from common attribute sources.
Saml2LoginEvent::getName() — Method in class Saml2LoginEvent: Get the name from common attribute sources.
Saml2::getFacadeAccessor() — Method in class Saml2
Saml2::getAuth() — Method in class Saml2
Saml2::getMetadataXml() — Method in class Saml2
Saml2::getIdpResolver() — Method in class Saml2
Saml2::getMetadataParser() — Method in class Saml2
AdminController::getSpMetadata() — Method in class AdminController: Get SP metadata info.
SetupController::getSpMetadata() — Method in class SetupController: Get SP metadata information.
Saml2Idp::getLoginUrl() — Method in class Saml2Idp: Get the login URL for this IDP.
Saml2Idp::getMetadataValue() — Method in class Saml2Idp: Get additional metadata value.
Saml2Idp::getAttributeMapping() — Method in class Saml2Idp: Get the effective attribute mapping for this IDP.
Saml2Setting::get() — Method in class Saml2Setting: Get a setting value by key.
MetadataParser::getSsoUrl() — Method in class MetadataParser: Get the SSO URL from the metadata.
MetadataParser::getSloUrl() — Method in class MetadataParser: Get the SLO URL from the metadata.
MetadataParser::getCertificates() — Method in class MetadataParser: Get all certificates from the metadata.
Saml2Service::getAuth() — Method in class Saml2Service: Get a configured Auth instance for an IDP.
Saml2Service::getMetadataXml() — Method in class Saml2Service: Generate SP metadata XML, with optional caching.
Saml2Service::generateMetadataXml() — Method in class Saml2Service: Generate SP metadata XML.
Saml2Service::getIdpResolver() — Method in class Saml2Service: Get the IDP resolver instance.
Saml2Service::getMetadataParser() — Method in class Saml2Service: Get the metadata parser instance.

H

CreateIdpCommand::handle() — Method in class CreateIdpCommand
DeleteIdpCommand::handle() — Method in class DeleteIdpCommand
GenerateSpCertCommand::handle() — Method in class GenerateSpCertCommand
ListIdpsCommand::handle() — Method in class ListIdpsCommand
PublishListenerCommand::handle() — Method in class PublishListenerCommand
RefreshIdpMetadataCommand::handle() — Method in class RefreshIdpMetadataCommand
ResetSetupCommand::handle() — Method in class ResetSetupCommand
TestIdpCommand::handle() — Method in class TestIdpCommand
$ Saml2Idp#hidden — Property in class Saml2Idp: The attributes that should be hidden for serialization.
Saml2Idp::hasCustomAttributeMapping() — Method in class Saml2Idp: Check if this IDP has custom attribute mapping.

I

InvalidIdpException — Class in namespace Beartropy\Saml2\Exceptions
AdminController::index() — Method in class AdminController: Dashboard - list all IDPs.
SetupController::index() — Method in class SetupController: Show the setup wizard page.
IdpRequest — Class in namespace Beartropy\Saml2\Http\Requests
Saml2Idp::isReady() — Method in class Saml2Idp: Check if the IDP is ready for use.
Saml2Setting::isSetupComplete() — Method in class Saml2Setting: Check if the setup has been completed (not first deploy).
Saml2Setting::isFirstDeploy() — Method in class Saml2Setting: Check if this is the first deploy (setup not complete).
IdpResolver — Class in namespace Beartropy\Saml2\Services

L

ListIdpsCommand — Class in namespace Beartropy\Saml2\Console\Commands
Saml2::login() — Method in class Saml2
Saml2::logout() — Method in class Saml2
Saml2Controller::login() — Method in class Saml2Controller: Initiate SSO login for an IDP.
Saml2Controller::logout() — Method in class Saml2Controller: Initiate logout via SAML SLO.
Saml2Service::login() — Method in class Saml2Service: Initiate SSO login for an IDP.
Saml2Service::logout() — Method in class Saml2Service: Initiate SLO logout.

M

Saml2Controller::metadata() — Method in class Saml2Controller: SP Metadata endpoint.
Saml2Setting::markSetupComplete() — Method in class Saml2Setting: Mark setup as complete.
MetadataParser — Class in namespace Beartropy\Saml2\Services
Saml2Service::mapAttributes() — Method in class Saml2Service: Map SAML attributes using the IDP-specific or global mapping.

N

InvalidIdpException::notFound() — Method in class InvalidIdpException
InvalidIdpException::notConfigured() — Method in class InvalidIdpException

P

PublishListenerCommand — Class in namespace Beartropy\Saml2\Console\Commands
Saml2::processAcsResponse() — Method in class Saml2
AdminController::parseMetadata() — Method in class AdminController: Parse metadata XML (AJAX endpoint for client-side fetch).
SetupController::parseText() — Method in class SetupController: Parse metadata from XML text.
SetupController::parseXml() — Method in class SetupController: Parse metadata XML sent from client-side fetch.
SetupController::prepareFormData() — Method in class SetupController: Prepare form data from parsed metadata.
MetadataParser::parseXml() — Method in class MetadataParser: Parse IDP metadata from XML string.
MetadataParser::parseFromUrl() — Method in class MetadataParser: Fetch and parse metadata from a URL.
Saml2Service::processAcsResponse() — Method in class Saml2Service: Process the ACS (Assertion Consumer Service) response.
Saml2Service::processAcsResponseAuto() — Method in class Saml2Service: Process ACS response by extracting the Issuer (IDP EntityID) from the SAML response.
Saml2Service::processAcsWithIdp() — Method in class Saml2Service: Process ACS with a resolved IDP.
Saml2Service::processSlo() — Method in class Saml2Service: Process the SLS (Single Logout Service) response/request.

R

RefreshIdpMetadataCommand — Class in namespace Beartropy\Saml2\Console\Commands
RefreshIdpMetadataCommand::refreshSingle() — Method in class RefreshIdpMetadataCommand
RefreshIdpMetadataCommand::refreshAll() — Method in class RefreshIdpMetadataCommand
RefreshIdpMetadataCommand::refreshIdp() — Method in class RefreshIdpMetadataCommand
ResetSetupCommand — Class in namespace Beartropy\Saml2\Console\Commands
AdminController::refreshMetadata() — Method in class AdminController: Refresh metadata from URL.
IdpRequest::rules() — Method in class IdpRequest
Saml2Setting::resetToFirstDeploy() — Method in class Saml2Setting: Reset to first deploy state.
Saml2ServiceProvider::register() — Method in class Saml2ServiceProvider: Register any application services.
IdpResolver::resolve() — Method in class IdpResolver: Resolve an IDP by its key.
IdpResolver::resolveFromEnv() — Method in class IdpResolver: Resolve IDP from environment configuration.
IdpResolver::resolveFromDatabase() — Method in class IdpResolver: Resolve IDP from database, with optional caching.
IdpResolver::resolveByEntityId() — Method in class IdpResolver: Resolve an IDP by its entity_id (used for ACS response lookup).

S

$ CreateIdpCommand#signature — Property in class CreateIdpCommand
CreateIdpCommand::saveIdp() — Method in class CreateIdpCommand
$ DeleteIdpCommand#signature — Property in class DeleteIdpCommand
$ GenerateSpCertCommand#signature — Property in class GenerateSpCertCommand
$ ListIdpsCommand#signature — Property in class ListIdpsCommand
$ PublishListenerCommand#signature — Property in class PublishListenerCommand
$ RefreshIdpMetadataCommand#signature — Property in class RefreshIdpMetadataCommand
$ ResetSetupCommand#signature — Property in class ResetSetupCommand
$ TestIdpCommand#signature — Property in class TestIdpCommand
Saml2LoginEvent — Class in namespace Beartropy\Saml2\Events
Saml2LogoutEvent — Class in namespace Beartropy\Saml2\Events
Saml2Exception — Class in namespace Beartropy\Saml2\Exceptions
Saml2 — Class in namespace Beartropy\Saml2\Facades
Saml2::static() — Method in class Saml2: ?string processSlo(string $idpKey, callable $cbDeleteSession = 'null')
AdminController::storeIdp() — Method in class AdminController: Store new IDP.
Saml2Controller — Class in namespace Beartropy\Saml2\Http\Controllers
Saml2Controller::sls() — Method in class Saml2Controller: Single Logout Service - process logout request/response.
Saml2Controller::sessionPrefix() — Method in class Saml2Controller: Get the configured session key prefix.
SetupController — Class in namespace Beartropy\Saml2\Http\Controllers
SetupController::success() — Method in class SetupController: Show the success page after setup.
SetupController::save() — Method in class SetupController: Save the IDP configuration.
Saml2Idp — Class in namespace Beartropy\Saml2\Models
Saml2Idp::scopeActive() — Method in class Saml2Idp: Scope to only include active IDPs.
Saml2Idp::setMetadataValue() — Method in class Saml2Idp: Set additional metadata value.
Saml2Setting — Class in namespace Beartropy\Saml2\Models
Saml2Setting::set() — Method in class Saml2Setting: Set a setting value by key.
Saml2ServiceProvider — Class in namespace Beartropy\Saml2
Saml2Service — Class in namespace Beartropy\Saml2\Services
UrlValidator::sanitizeRedirect() — Method in class UrlValidator: Ensure a redirect URL is safe (relative path only, no protocol-relative URLs).

T

TestIdpCommand — Class in namespace Beartropy\Saml2\Console\Commands
Saml2LoginEvent::toArray() — Method in class Saml2LoginEvent: Get all event data as an array.
AdminController::toggleIdp() — Method in class AdminController: Toggle IDP active status.
$ Saml2Idp#table — Property in class Saml2Idp: The table associated with the model.
Saml2Idp::toIdpSettings() — Method in class Saml2Idp: Convert to onelogin/php-saml IDP settings array.
$ Saml2Setting#table — Property in class Saml2Setting: The table associated with the model.

U

AdminController::updateIdp() — Method in class AdminController: Update existing IDP.
AdminController::updateMapping() — Method in class AdminController: Update attribute mapping.
UrlValidator — Class in namespace Beartropy\Saml2\Support

V

TestIdpCommand::validateCertificate() — Method in class TestIdpCommand
MetadataParser::validateUrlNotInternal() — Method in class MetadataParser: Validate that a URL does not point to internal/private network addresses.

_

CreateIdpCommand::__construct() — Method in class CreateIdpCommand
ListIdpsCommand::__construct() — Method in class ListIdpsCommand
PublishListenerCommand::__construct() — Method in class PublishListenerCommand
RefreshIdpMetadataCommand::__construct() — Method in class RefreshIdpMetadataCommand
TestIdpCommand::__construct() — Method in class TestIdpCommand
Saml2LoginEvent::__construct() — Method in class Saml2LoginEvent: Create a new event instance.
Saml2LogoutEvent::__construct() — Method in class Saml2LogoutEvent: Create a new event instance.
AdminController::__construct() — Method in class AdminController
Saml2Controller::__construct() — Method in class Saml2Controller
SetupController::__construct() — Method in class SetupController
Saml2Service::__construct() — Method in class Saml2Service