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.
com.ibm.commerce.rest.member.handler.LTPAIdentityHandler
HTTP Method | Path | Description |
---|---|---|
POST | /store/{storeId}/ltpaidentity | Authenticates a user using an LTPA token. |
DELETE | /store/{storeId}/ltpaidentity/@self | Logs out the user. |
Authenticates a user using an LTPA token.
authenticate
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
body | LTPA logon body. | body | com.ibm.commerce.rest.member.handler.LTPAIdentityHandler$LtpaLoginForm | false | N/A |
HTTP Status Code | Description |
---|---|
201 | The requested resource has been created. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.member.handler.LTPAIdentityHandler$UserIdentity
Logs out the user.
logout
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
Information required to authenticate a user using LTPA.
Name | Data Type | Required |
---|---|---|
LTPAToken | string | true |
Information about a guest user identity.
Name | Data Type | Required |
---|---|---|
userId | string | true |
WCToken | string | true |
WCTrustedToken | string | true |
personalizationID | string | true |