Enables you to implement a mechanism to log the user into the Pega Platform.
An instance of the PegaAuthenticator object is created by calling the
authenticator
method.
| Name | Description | Type | Use |
|---|---|---|---|
| loginActivity | The LoginActivityType enum that defines a login activity used for the selected Pega Platform instance. | object |
optional |
| url | A URL address of the Pega Platform instance that you want to log the user into. You must set a URL for each authenticator instance. Once set, all three methods (logIn, logOff, isLoggedIn) will use the same URL and optionally loginActivity | string |
required |
| Name | Description |
|---|---|
| logIn | Attempts to authenticate the user against the Pega Platform instance. |
| logOff | Logs the user out of the Pega Platform instance. |
| isLoggedIn | Verifies if the user is logged into the Pega Platform instance. |