Skip navigation
 

Authentication Module Methods Overview
Added by George Kroner, last edited by George Kroner on 18 Dec 2007 12:14 AM
(None)

Methods specific to different types of Authentication Modules

Not all AuthenticationModule methods are applicable to all types of authentication modules.

getSSOUrl(authModuleGroupName,actionName)

getSSOUrl() is used in outbound authentication modules that require an SSO callback URL. For example, if the outbound authentication module invokes an external application that needs to send information back to Vista, you can call getSSOUrl() to return the URL of an inbound auth mod and then send the URL as a parameter in the request to the external application. The authModuleGroupNamemust be the group name of an inbound authentication module. If you use the group name of an outbound authentication module with getSSOUrl() it will throw a LoginException.

getGUID()

This method returns a non-null value only when the proxy tool has the AssistedConfig setting turned on and it was invoked during assisted configuration. If you call this method in an inbound request or if it is a non-assisted config outbound request, it will return null.
NOTE: the GUID is not a permanent identifier for the proxy tool. The format of the GUID may change in future releases.

getRequest()

If the authentication module is invoked by the Context web service's login(GroupName?, lcid, settings) method, the request is null. If you want to access the values that were passed by the login method, use the authmod's getSettings() method.

getSettings(), getSettings(glcid), getSettings(sourceName, sourceId)

The values in the map returned by getSettings() are somewhat different, depending how the auth mod was called.

  • For an outbound request, the map will contain proxy tool settings.
  • For an inbound SSO URL request, the map will contain the auth mod's settings.
  • For an inbound proxy request, generated by a call to Context.login(authModGroupName, lcid, settings), the map will contain the values passed in the login(authModGroupName, lcid, settings) method's settings parameter as well as the auth mod's settings.
This article originally authored by Paul Monk on the WebCT DevNet

Adaptavist Theme Builder Powered by Atlassian Confluence

By accessing the Knowledge Base, you agree to the following: Blackboard makes no representations or warranties as to the accuracy of any information in the Knowledge Base. Blackboard is not responsible in any way for information provided to the Knowledge Base by third parties. Information in the Knowledge Base is not documentation for any Blackboard product. Nothing in the Knowledge Base shall be deemed to modify your license in any way to any Blackboard product. Blackboard reserves the right to use your name and the name of your institution in reference to any information submitted by you to the Knowledge Base. Blackboard may modify, distribute, republish in any format, delete, incorporate or use in any way the information that you contribute to the Knowledge Base.