options |
Object | String |
The configuration object to use.
The options object is a JSON object, here an example.
{
openam: myOpenAMConfigObject,
module: "DataStore", // optional
service: "ldapService", // optional
width: "600px", // optional
height: "300px", // optional
formId: "amLoginForm", // optional
gotoURL: "http://ap.example.com:8880/exampleNRO02.html", // optional
social: true, // optional
overrideSocialImplementations: mySocialImplementationsObject // optional
}
Properties
openam |
Object | String |
|
|
The OpenAM Configuration Object. This is a mandatory attribute. See openam.js documentation for more information |
module |
String |
<optional>
|
OpenAM realm default |
The Authentication module to use in the left side of the login box. |
service |
String |
<optional>
|
OpenAM realm default |
The Authentication service chain to use in the left side of the login box. Notice that service takes precedence over module. |
width |
String |
<optional>
|
270px or as defined in openamUtils.css |
The Login Box width in px. |
height |
String |
<optional>
|
620px or as defined in openamUtils.css |
The Login Box height in px. |
formId |
String |
<optional>
|
amLoginForm |
The id of the form to be used to capture the credentials. It is recommended not to change it, unless there is a form Id colision in your HTML code. |
gotoURL |
String |
<optional>
|
Current page |
The URL to go to after a successful authentication. |
social |
String |
<optional>
|
true |
Boolean attribute to turn off the display of the social authentication buttons, if the OpenAM has been configured to show the social implementations in the login page. |
overrideSocialImplementations |
Array.<Object> |
<optional>
|
|
This array of objects will override the socialImplementations array that is returned from the OpenAM serverinfo URL.
Here an example of the overrideSocialImplementations object:
[
{
"authnChain": "GoogleSocialAuthenticationService",
"displayName": "Google",
"iconPath": "images/google.png",
"imgStyle": "display: block; max-width: 80% !important;",
"valid": true,
"buttonText": ''
},
{
"authnChain": "MicrosoftSocialAuthenticationService",
"displayName": "Microsoft",
"iconPath": "images/msn.png",
"imgStyle": "display: block; max-width: 80% !important;",
"valid": true,
"buttonText": ''
}
]
Properties
authnChain |
String |
|
|
The name of the authentication chain that implements the specified social authentication |
displayName |
String |
|
|
The name to be displayed for the specified social authentication |
iconPath |
String |
|
|
The location of the icon to be displayed within the button for the specified social authentication |
imgStyle |
String |
<optional>
|
"float: left;" |
The CSS style to be applied to the image referred in the iconPath attribute |
valid |
Boolean |
<optional>
|
true |
Flag to specify if the socialImplementation object should be used or not |
buttonText |
String |
<optional>
|
Sign in with <displayName> |
The text to be written within the button for the specified social authentication |
|
|