Skip to main content

Table of Contents

Specifying preauthentication and postauthentication activities for a SAML SSO authentication service


Only available versions of this content are shown in the dropdown

To customize the login process, you can write activities that are triggered before and after SAML SSO authentication. For example, a postauthentication activity can update the operator record with values from the service provider or refuse an automatically provisioned user access to an application.

  1. Create your preauthentication and postauthentication activities. For more information, see the sample activities pySSOPreAuthenticationActivity and pySSOPostAuthenticationActivity. When you write these activities, consider the following:

    • Update the pega Browser requestor type's default access group to equal an access group that includes the ruleset of the preauthentication activity. The preauthentication activity must be accessible to the pega Browser requestor type, which is used for the unauthenticated user session. By default, this requestor type is assigned to the PRPC:Unauthenticated access group.
    • Create the postauthentication activity in a ruleset that is accessible to the user's default access group. The postauthentication activity must be accessible to the user who has just been authenticated.
    • Set the Applies To key part of the activities to Code-Security.
    • Set the authentication result in pyAuthenticationPolicyResult to true to proceed with authentication, or set to false to terminate the request; for example:
       tools.getRequestor().getRequestorPage().putString("pyAuthenticationPolicyResult", "true");
    • You can dynamically update the user’s role list by using a postauthentication activity. This is useful if you want to dynamically add roles to the user context at login without maintaining multiple access groups in the database for all combinations of roles. In the postauthentication activity, update the list of roles by calling setRoles, as shown in the following example.
       tools.getAuthorizationHandle().setRoles(tools, tools.getAuthorizationHandle().UPDATE_APPEND, rolesList);
      Roles that you set in the postauthentication activity without saving the access group to the database lose their effect if the user switches applications. To dynamically add roles in a way that supports switching applications, see How to dynamically add roles during user authentication.
  2. Open the service from the navigation panel in Dev Studio by clicking Records SysAdmin Authentication Service and choosing a service from the instance list.

  3. On the SAML 2.0 tab, expand the Advanced configuration settings section.

  4. In the Pre-authentication activity field, enter the name of the preauthentication activity.

  5. In the Post-authentication activity field, enter the name of the postauthentication activity.

  6. Click Save.

Did you find this content helpful?

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega Community has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice
Contact us