POST v1/store/sso
Generates single sign-on url
Request Information
URI Parameters
None.
Body Parameters
SsoModel| Name | 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": "a8449e37-287e-4220-99a3-6ba89ffd9344",
"CultureID": "d3a804c0-6480-45d0-95bc-7bc358c51e01",
"CurrencyID": "549026c3-5331-438e-9eaf-66816720a6ad",
"SingleCartListID": "e2d8fd1d-1392-4171-89b5-dc4750e8e090",
"AddToCartUrl": "sample string 5",
"LogoutUrl": "sample string 6",
"CancelUrl": "sample string 7",
"EntityID": "99cf2182-420d-45e8-b94e-49b1be8e1a6c",
"Page": 1
}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
SsoResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Url |
The single sign-on url. |
string |
None. |
Response Formats
application/json, text/json
{
"Url": "sample string 1"
}