Samples > Sample stores > Consumer direct sample store > IBM Gift Center for the Consumer direct sample store > IBM Gift Center > Customize the Web (presentation) layer > IBM Gift Center actions
GiftRegistryAuthentication action
This action grants access to the gift registry to any user (whether a gift registrant, co-registrant, or a gift giver). If the user is authenticated, the action creates a gift registry context for the user.
Use this action with SSL (Secure Sockets Layer) to ensure that all personal information is encrypted.
To do so, type the action with the HTTPS secure protocol.
URL structure
- http://host/path/
- The fully qualified name of the WebSphere Commerce Server and the configuration path (for example, wcserver.mydomain.ibm.com is fully qualified).
name-value pair with the &
character. For a detailed description of the parameters and their values, see the list entitled Parameter values." />
Parameter values
- URL
- Required: The URL to be called when the action completes successfully.
- storeId
- Required: The store reference number, which is required to help identify to which stores a gift registry belongs.
- externalId
- Required: The unique gift registry identifier.
- password
- The password to access the gift registry. The gift registrant defines the password when creating the gift registry. Contrast with the regAccessKey and guestAccessKey parameters. Note that if the user has already logged onto the WebSphere Commerce system and is the gift registrant for this gift registry, the password is not required.
- regAccessKey
- A system-generated access key for the gift registrant or co-registrant to access the gift registry. Contrast with the password parameter.
- guestAcessKey
- A system-generated access key for the guest (gift giver) to access the gift registry. Contrast with the password parameter.
- errorViewName
- Overrides the error view when an error occurs.
Example
The following example authenticates gift givers to work with gift registry 888 at store 1001. The gift registrant has set up a password for authorized users (gift givers) to access the gift registry.
https://myhostname/webapp/wcs/stores/servlet/GiftRegistryAuthentication? URL=/webapp/wcs/stores/servlet/&storeId=1001 &externalId=888&password=pass123word
Behavior
- Upon
successful completion, the specified URL is called.
- Authenticates
a user to access the specified gift registry.
- If unsuccessful, the action redirects to the error view.
Exception conditions
- If a required
parameter is not specified, the system throws an exception
with the _ERR_CMD_MISSING_PARAMETER message key.
- If invalid
credentials are specified, such as an improper password, the
system throws an exception with the _ERR_INVALID_CREDENTIALS message
key.
- If the a password is not specified, the system redirects
the user to a
password page with the _ERR_EC_AUTHENTICATION_PASSWORD_REQUIRED message
key.
Note that if the user has already logged onto the WebSphere Commerce system
and is the gift registrant for this gift registry, the password is
not required.
- If the password specified is invalid, the system
throws an exception with
the _ERR_EC_AUTHENTICATION_PASSWORD_FAILED message key. Note that
if the user
has already logged onto the WebSphere Commerce system and is the gift
registrant
for this gift registry, the password is not required.
- If the system encounters a security problem, such as a user attempting to access the gift registry without the appropriate authorization, the system throws an exception with the _ERR_NOT_AUTHORIZED message key.
Related concepts
Related reference
Overview of customizing IBM Gift Center