Version: 2.3
Category: Input
Extended Category: String
Action Package: Standard Actions
Description
Adds an attribute with a given value to the session.
If the attribute name is unicodePwd, the value will automatically be converted to Microsoft Active Directory format.
Supports SESSION and GLOBAL parameters.
|
Parameter |
Description |
Example |
|
Attribute Name(s) |
Enter the name of the Session Attribute to create. If the Session Attribute already exists, the value in that attribute will be exchanged to this value. Supports multiple attributes, separated with comma (,), that will all get the same value unless the separator in parameter 7 is set. |
carLicense |
|
Attribute Value |
Select the value. Use [LINEBREAK] to insert a line break. |
ABC123,AIK324 |
|
Is Multivalue (true/false) |
Is multivalue (comma separated or configurable in the next parameter). Default: false |
true |
|
Multivalue Separator |
The multivalue separator if not using comma (,). The parameter “Is Multivalue” must be set to true. |
, |
|
Skip Attributes Not Empty (true/false) |
Only update the attribute if it does not already contain a value (true) or always overwrite any existing value (false). Default: false. |
true |
|
Convert Multivalue Separator |
If an attribute used in SESSION() in the parameter value has a multi value and the result attribute is single value, the multi value will be converted to a single value. Enter the separator to use between the values. Use NONE for no separator. Default separator for the values is a space. |
; |
|
Multiple Attributes Value Separator |
If entering multiple attribute names, you can create multiple attributes with different values by entering a separator here. If more attribute names are entered than values, the last value will be used for the excess names. Can not be used to create multivalue attributes. |
; |
Use Cases
Example 1: Disable an account
This action will add the attribute userAccountControl with the value 514. If this attribute later is written to a LDAP directory, the user account will be disabled.
|
Parameter |
Value |
|
Attribute Name |
userAccountControl |
|
Attribute Value |
514 |
|
Is Multivalue (true/false) |
[BLANK] |
|
Multivalue Separator |
[BLANK] |
|
Skip Attributes Not Empty (true/false) |
[BLANK] |
|
Convert Multivalue Separator |
[BLANK] |
|
Multiple Attributes Value Separator |
[BLANK] |
Example 2: Create a fullname
This action will add the attribute fullname, containing the value in the attributes givenname and sn, separated with a space.
|
Parameter |
Value |
|
Attribute Name |
fullname |
|
Attribute Value |
SESSION(givenname) SESSION(sn) |
|
Is Multivalue (true/false) |
[BLANK] |
|
Multivalue Separator |
[BLANK] |
|
Skip Attributes Not Empty (true/false) |
[BLANK] |
|
Convert Multivalue Separator |
[BLANK] |
|
Multiple Attributes Value Separator |
[BLANK] |
Example 3: Add objectClass
When creating a user account in a LDAP directory the attribute objectClass must be included in the call. The attribute objectClass is a multi value attribute.
|
Parameter |
Value |
|
Attribute Name |
objectClass |
|
Attribute Value |
person,user |
|
Is Multivalue (true/false) |
true |
|
Multivalue Separator |
, |
|
Skip Attributes Not Empty (true/false) |
[BLANK] |
|
Convert Multivalue Separator |
[BLANK] |
|
Multiple Attributes Value Separator |
[BLANK] |
DISCLAIMER
Information provided in this document is for your information only. PhenixID makes no explicit or implied claims to the validity of this information. Any trademarks referenced in this document are the property of their respective owners.The origin of this information may be internal or external to PhenixID. PhenixID makes all reasonable efforts to verify this information.
PhenixID - support.phenixid.se