RapidIdentity Product Guide: New UI

Profiles Actions
getPortalChallengeSetPolicy

Retrieve the Challenge Set information for a target DN

Property

Value

Description

connection*

expression, variable

the Portal connection definition

targetDN*

text, expression, variable

the DN of the target to query

returnVariable

expression, variable

name of the variable to be assigned to the return value

The returned object is a record which will have the following fields:

Field

Description

“challengePolicyId”

The ID of the ARMS Challenge Policy associated with the target

“adminQuestions”

The Admin questions required by the Challenge Policy (if any)

“numUserQuestions”

The number of User questions required by the Challenge Policy (may be 0)

Example

targetDN = "CN=user,OU=people,DC=example,DC=com"
challengeSetupDefn = getPortalChallengeSetPolicy(connection,
     targetDN)
challengePolicyId = getRecordFieldValue(challengeSetupDefn, 
    "challengePolicyId")
adminQuestions = getRecordFieldValues(challengeSetupDefn, 
    "adminQuestions")
numUserQuestions = getRecordFieldValue(challengeSetupDefn, 
    "numUserQuestions")
isPasswordValidForPortalUser

Determines if the provided password is valid for the specified User's current Portal Password Policy.

Property

Value

Description

returnVariable

expression, variable

name of the variable to be assigned to the return value

connection*

expression, variable

the Portal connection object obtained from invoking definePortalConnection

password*

text

the password to check for validity

userDNOrId

text, expression, variable

the ID or DN or the user to check password validity for

<?xml version="1.0"?>

<actionDefs xmlns="urn:idauto.net:dss:actiondef">
    <actionDef description="" returnsValue="false" category="" name="IsPasswordValidExample" modifiedByName="jdoe" modifiedBy="c9342e80-17bb-4678-9680-6ae9e0be8b7d" modifiedMs="1612898749146" changeCount="45">
        <argDefs/>
        <actions>
            <action name="definePortalConnection" outputVar="portalConn" id="A7368B04-FF9C-4244-BABD-F64E9EA66AF3">
                <arg name="url" value=""https://localhost:8443""/>
                <arg name="username" value=""jdoe""/>
                <arg name="password" value="$$$pwd("PCobDWI6uOachVjs1aIXVhODICqm42vCFCcyBtWNVrI=")"/>
                <arg name="login" value="true"/>
            </action>
            <action name="isPasswordValidForPortalUser" outputVar="isValid" id="6B83F0BA-5DE2-47FF-42DE-8C09B1A84FD1">
                <arg name="connection" value="portalConn"/>
                <arg name="password" value="$$$pwd("dnqHb+y/tFMeti5LSLyoxxPrfWxayv42dImrvZBe3Mc=")"/>
                <arg name="userDNOrId" value=""cn=jdoe,ou=employees,ou=people,o=idauto,dc=meta""/>
            </action>
            <action name="if" id="E067F4C3-0AF8-49E8-B993-4142CBA84BB1">
                <arg name="condition" value="isValid"/>
                <arg name="then">
                    <action name="log" id="DB027DFE-DA3C-4D4F-89F9-B005BF3D4A87">
                        <arg name="message" value=""The password is valid""/>
                        <arg name="level" value=""INFO""/>
                    </action>
                </arg>
                <arg name="else">
                    <action name="log" id="D2B79B09-D4CD-480E-A3FC-23787821DD12">
                        <arg name="message" value=""The password is invalid""/>
                        <arg name="level" value=""INFO""/>
                    </action>
                </arg>
            </action>
        </actions>
    </actionDef>
</actionDefs>
setPortalChallengeSetAnswers

Set challenge questions and answers for a target DN

Property

Value

Description

connection*

expression, variable

the Portal connection definition

targetDN*

text, expression, variable

the DN of the target whose challenge questions will be updated

challengePolicyId*

text, expression, variable

the ID of the Portal Challenge Policy for the target

adminQAs

text, expression, variable

Record containing Admin questions and associated answers

userQAs

text, expression, variable

Record containing User questions and associated answers

helpdeskQAs

text, expression, variable

Record containing Helpdesk questions and associated answers

returnVariable

expression, variable

name of the variable to be assigned to the return value

Example

adminQAs = createRecord(false)
addRecordFieldValue(adminQAs, "Admin Question 1", "Admin Answer 1", 
    false)
addRecordFieldValue(adminQAs, "Admin Question 2", "Admin Answer 2", 
    false)
userQAs = createRecord(false)
addRecordFieldValue(userQAs, "User Question 1", "User Answer 1", 
    false)
addRecordFieldValue(userQAs, "User Question 2", "User Answer 2", 
    false)
# Example of creating a Record from an object literal
helpdeskQAs = createRecordFromObject({"Helpdesk Question 1": 
    "Helpdesk Answer 1"})
success = setPortalChallengeSetAnswers(connection, targetDN, 
    challengePolicyId, adminQAs, userQAs, helpdeskQAs)
getPortalDefaultPasswordPolicyID

Retrieves the ID of the default Portal Password Policy.

Property

Value

Description

connection*

expression, variable

the Portal connection definition

returnVariable

expression, variable

name of the variable to be assigned to the return value

Example

defaultPolicyId = getPortalDefaultPasswordPolicyID(connection)
getPortalPasswordPolicyID

Retrieves the ID of the Portal Password Policy associated with a particular user.

Property

Value

Description

connection*

expression, variable

the Portal connection definition

userDNorID*

text, expression, variable

the DN or IdautoID of the target user

returnVariable

expression, variable

name of the variable to be assigned to the return value

Example

defaultPolicyId = getPortalPasswordPolicyID(connection)
generatePortalPasswordForUser

Generates a random password for a user based on their current Portal Password Policy.

Property

Value

Description

connection*

expression, variable

the Portal connection definition

userDNorID*

text, expression, variable

the DN or IdautoID of the target user

returnVariable

expression, variable

name of the variable to be assigned to the return value

Example

randomPassword = generatePortalPasswordForUser(connection, 
    "CN=John Simpson,OU=people,DC=example,DC=com")
generatePortalPasswordForPolicy

Generates a random password based on the specified Portal Password Policy ID.

Property

Value

Description

connection*

expression, variable

the Portal connection definition

policyId*

text, expression, variable

the Portal Password Policy ID

returnVariable

expression, variable

name of the variable to be assigned to the return value

Example

policyId = getPortalDefaultPasswordPolicyID(connection)
randomPassword = generatePortalPasswordForPolicy(connection, policyId)
In this section: