POST v1/store/sso

Generates single sign-on url

Request Information

URI Parameters

None.

Body Parameters

SsoModel
NameDescriptionTypeAdditional information
PowerUserEmail

The power user's email address.

string

None.

PowerUserPassword

The power user's password.

string

None.

Email

The impersonated user's email address.

string

None.

StoreID

The store ID.

globally unique identifier

None.

CultureID

The culture ID.

globally unique identifier

None.

CurrencyID

The currency ID.

globally unique identifier

None.

SingleCartListID

The shopping cart list ID that will be used in the single-list mode.

globally unique identifier

None.

AddToCartUrl

The URL to which the user will be redirected when adding an item to the Shopping Cart.

string

None.

LogoutUrl

The URL to which the user will be redirected when logging out of the Store.

string

None.

CancelUrl

The URL to which the user will be redirected when clicking Cancel or Back on the first page of the order wizard.

string

None.

EntityID

The ID of the entity that will be used within a context of a specific page.

globally unique identifier

None.

Page

The target landing page.

StorefrontPage

None.

Request Formats

application/json, text/json

Sample:
{
  "PowerUserEmail": "sample string 1",
  "PowerUserPassword": "sample string 2",
  "Email": "sample string 3",
  "StoreID": "9e1c61d5-03eb-4fd8-83f5-5732a9262e8e",
  "CultureID": "917f283b-fd50-445f-ad5d-ad6715f2149f",
  "CurrencyID": "eabcb2b8-338d-4b1c-8429-19641126e038",
  "SingleCartListID": "36c847da-9427-4e25-82c7-066908b0b438",
  "AddToCartUrl": "sample string 5",
  "LogoutUrl": "sample string 6",
  "CancelUrl": "sample string 7",
  "EntityID": "a1db5657-f766-41ae-8395-60200ab71198",
  "Page": 1
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SsoResponseModel
NameDescriptionTypeAdditional information
Url

The single sign-on url.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Url": "sample string 1"
}