guest_identity

This class provides RESTful services to create a guest and log the guest out. It performs the service by delegating to the Person BOD service.

Handler Class:

com.ibm.commerce.rest.member.handler.GuestIdentityHandler

Summary

Path Operation Description
/store/{storeId}/guestidentity POST

Creates identity tokens for a guest user.

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

Logs out a guest user.

Paths

Creates identity tokens for a guest user.

POST /store/{storeId}/guestidentity

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

200 OK

No response was specified

201 Created

The requested resource has been created.

400 Bad Request

Bad request. Some of the inputs provided to the request aren't valid.

401 Unauthorized

Not authenticated. The user session isn't valid.

403 Forbidden

The user isn't authorized to perform the specified request.

404 Not Found

The specified resource couldn't be found.

500 Internal Server Error

Internal server error. Additional details will be contained on the server logs.

Logs out a guest user.

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

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

200 OK

The requested completed successfully.

400 Bad Request

Bad request. Some of the inputs provided to the request aren't valid.

401 Unauthorized

Not authenticated. The user session isn't valid.

403 Forbidden

The user isn't authorized to perform the specified request.

404 Not Found

The specified resource couldn't be found.

500 Internal Server Error

Internal server error. Additional details will be contained on the server logs.

Schema definitions

com.ibm.commerce.rest.member.handler.GuestIdentityHandler$UserIdentity: object

Information about a guest user identity.

WCToken: string

The token used for authentication.

WCTrustedToken: string

The trusted token used for authentication. This token should only be used on encrypted channels.

personalizationID: string

The personalization identifier for the current session.

userId: string

The user unique identifier.

Empty: object

Empty model. Used as default value when no model is specified.