Performs authentication process to Pega 7.
When authentication is successful session cookies will be set.
| Name | Description | Type | Use |
|---|---|---|---|
| url | The base URL pointing to the Pega 7 servlet. | string |
required |
| user | The name of the user for authentication. | string |
required |
| password | The password of the user for authentication. | string |
required |
| callbacks | Passed to verify whether the Pega 7 authentication process was successful or not. | undefined |
required |
| force | This optional parameter clears the previous session (if there was one) before authentication. It's default value is "false". | boolean |
optional |
The authenticate method's callbacks object can be
structured as follows:
1 2 3 4 | { onSuccess: function( result ) {...}, onFailure: function( {code, description} ) {...}} |
The table below lists all callbacks supported by the method.
| Name | Description | Return type |
|---|---|---|
| onSuccess | Invoked when authentication process was successful. The The returned |
undefined |
| onFailure |
Invoked when the authentication process has failed for any reason. Specifies the type of the last failure, as defined in the
Constants section of the Authentication article. An |
undefined |