Skip to content
Snippets Groups Projects
Commit 87024341 authored by Patrick Radtke's avatar Patrick Radtke
Browse files

Update core:PHP doc to discuss $state variable

parent f4c4381f
No related branches found
No related tags found
No related merge requests found
`core:PHP` `core:PHP`
========== ==========
This is a filter which makes it possible to run arbitrary PHP code to modify the attributes of an user. This is a filter which makes it possible to run arbitrary PHP code to modify the attributes or state of an user.
Parameters Parameters
---------- ----------
...@@ -11,8 +11,14 @@ Parameters ...@@ -11,8 +11,14 @@ Parameters
It must be `'core:PHP'`. It must be `'core:PHP'`.
`code` `code`
: The PHP code that should be run. This code will have only one variable available: `$attributes`. : The PHP code that should be run. This code will have two variables available:
* `$attributes`.
This is an associative array of attributes, and can be modified to add or remove attributes. This is an associative array of attributes, and can be modified to add or remove attributes.
* `$state`.
This is an associative array of request state. It can be modified to adjust data related to the authentication
such as desired NameId, requested Attributes, authnContextRef and many more.
Examples Examples
-------- --------
...@@ -43,3 +49,10 @@ Create a random number variable: ...@@ -43,3 +49,10 @@ Create a random number variable:
); );
', ',
), ),
Force a specific NameIdFormat. Useful if an SP misbehaves and requests (or publishes) an incorrect NameId
90 => array(
'class' => 'core:PHP',
'code' => '$state["saml:NameIDFormat"] = "urn:oasis:names:tc:SAML:2.0:nameid-format:transient";'
),
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment