POST v1/store/sso
Generates single sign-on url
Request Information
URI Parameters
None.
Body Parameters
SsoModelName | Description | Type | Additional information |
---|---|---|---|
PowerUserEmail |
The power user's email address. |
string |
None. |
PowerUserPassword |
The power user's password. |
string |
None. |
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
{ "PowerUserEmail": "sample string 1", "PowerUserPassword": "sample string 2", "Email": "sample string 3", "StoreID": "d2e27dec-1f94-48b9-be29-2688cad4b425", "CultureID": "a338df50-e09b-493d-8a9a-b6823c5be2c7", "CurrencyID": "b496cf71-134f-4818-9d44-3047422759c6", "SingleCartListID": "d0a8a60d-9a58-400d-a07a-67b453fd848c", "AddToCartUrl": "sample string 5", "LogoutUrl": "sample string 6", "CancelUrl": "sample string 7", "EntityID": "d37288e0-465e-4dbe-aba0-ef896a3ccb8d", "Page": 1 }
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
SsoResponseModelName | Description | Type | Additional information |
---|---|---|---|
Url |
The single sign-on url. |
string |
None. |
Response Formats
application/json, text/json
{ "Url": "sample string 1" }