This class provides RESTful services to login and logout a registered shopper using their user name and password. It performs the service by delegating to the Person BOD service.
com.ibm.commerce.rest.member.handler.LoginIdentityHandler
Path | Operation | Description |
---|---|---|
/store/{storeId}/loginidentity | POST |
Logs in a registered user using their user name and password. |
/store/{storeId}/loginidentity/@self | DELETE |
Logs out the registered user. |
application/json application/xml
storeId | The store identifier. |
path | string , x ∈ { 715839284 , 0 , 715839134 , 715839184 , 715839234 , 715837884 , 715838634 , 715839334 , 715837934 , 715837984 , 715838034 , 715838534 , 715838584 , 715838035 , 715838036 } | |
responseFormat | The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn't specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn't specified as well, the default response format shall be in json. |
query | string , x ∈ { xml , json } |
application/json application/xml application/xhtml+xml application/atom+xml
No response was specified
The requested resource has been created.
Bad request. Some of the inputs provided to the request aren't valid.
Not authenticated. The user session isn't valid.
The user isn't authorized to perform the specified request.
The specified resource couldn't be found.
Internal server error. Additional details will be contained on the server logs.
storeId | The store identifier. |
path | string , x ∈ { 715839284 , 0 , 715839134 , 715839184 , 715839234 , 715837884 , 715838634 , 715839334 , 715837934 , 715837984 , 715838034 , 715838534 , 715838584 , 715838035 , 715838036 } | |
responseFormat | The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn't specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn't specified as well, the default response format shall be in json. |
query | string , x ∈ { xml , json } |
application/json application/xml application/xhtml+xml application/atom+xml
The requested completed successfully.
Bad request. Some of the inputs provided to the request aren't valid.
Not authenticated. The user session isn't valid.
The user isn't authorized to perform the specified request.
The specified resource couldn't be found.
Internal server error. Additional details will be contained on the server logs.
Information required to authenticate a user.
The logon id.
The logon password.
Information about a guest user identity.
The token used for authentication.
The trusted token used for authentication. This token should only be used on encrypted channels.
The markerting tracking consent. 0 means opt-out, 1 means opt-in.
The personalization identifier for the current session.
The version of the privacy notice. For example '1.0'.
The user unique identifier.