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": "661e9805-4441-4d40-aea2-b926ccb2d7ee",
"CultureID": "2d473a08-7584-46ac-b0a5-b1871d696273",
"CurrencyID": "ce3b47bd-6249-47cf-a830-b10d3e9eaa5c",
"SingleCartListID": "ec3b4d76-8862-4103-bd58-21497391fe74",
"AddToCartUrl": "sample string 5",
"LogoutUrl": "sample string 6",
"CancelUrl": "sample string 7",
"EntityID": "660e773d-b89a-4ed8-828e-bf1f95e9f94e",
"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"
}