ltpa_identity

This class provides RESTful services to login and logout a registered user using an LTPA token. It performs the service by delegating to the Person BOD service.

Handler Class:

com.ibm.commerce.rest.member.handler.LTPAIdentityHandler

Method Summary

HTTP MethodPathDescription
POST/store/{storeId}/ltpaidentityAuthenticates a user using an LTPA token.
DELETE/store/{storeId}/ltpaidentity/@selfLogs out the user.

Method Details

POST /store/{storeId}/ltpaidentity

Authenticates a user using an LTPA token.

Handler Method:

authenticate

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
bodyLTPA logon body.bodycom.ibm.commerce.rest.member.handler.LTPAIdentityHandler$LtpaLoginFormfalseN/A
HTTP Status Codes:
HTTP Status CodeDescription
201The requested resource has been created.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
404The specified resource couldn't be found.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

com.ibm.commerce.rest.member.handler.LTPAIdentityHandler$UserIdentity

DELETE /store/{storeId}/ltpaidentity/@self

Logs out the user.

Handler Method:

logout

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
404The specified resource couldn't be found.
500Internal server error. Additional details will be contained on the server logs.

Data Type Details

com.ibm.commerce.rest.member.handler.LTPAIdentityHandler$LtpaLoginForm

Information required to authenticate a user using LTPA.

Properties:
NameData TypeRequired
LTPATokenstringtrue

com.ibm.commerce.rest.member.handler.LTPAIdentityHandler$UserIdentity

Information about a guest user identity.

Properties:
NameData TypeRequired
userIdstringtrue
WCTokenstringtrue
WCTrustedTokenstringtrue
personalizationIDstringtrue