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": "83bdb22e-7c2a-49b9-87df-e94ffb383e1a",
"CultureID": "e08bb64b-36f8-4429-b5bb-c8a6a2088c05",
"CurrencyID": "1044fce1-a1da-4636-9ed8-d087b6dbd62c",
"SingleCartListID": "66143242-b5da-4411-aa1f-71d290bd1def",
"AddToCartUrl": "sample string 5",
"LogoutUrl": "sample string 6",
"CancelUrl": "sample string 7",
"EntityID": "dbdb87e9-e703-43ce-b924-5e42c6014093",
"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"
}