PUT api/{enterpriseId}/Sso/CreateSamlResponse
Used by GlobalSync in CRMOnline to create an SSO session and url The method name is historical and no longer generates saml
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| enterpriseId | string |
Required |
Body Parameters
SsoModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
OpaqueId in SSODynamicUserConfig |
string |
None. |
| AppCode |
From SSOApplicationConfig |
string |
None. |
| PartyCode |
From SSOConfig |
string |
None. |
| CrmSSOAccountId |
CRM Account ID |
string |
None. |
| PageName |
The name of the page the user will land on |
string |
None. |
| Id |
An ID understood by the Page, such as HouseholdId |
string |
None. |
| TabName |
Specifies the name of the tab on the page to open |
string |
None. |
| Type |
Determins AccountTypeID |
string |
None. |
| ViewAsClient |
Redirects to Clients.aspx?ClientExternalId=??? |
boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"UserId": "sample string 1",
"AppCode": "sample string 2",
"PartyCode": "sample string 3",
"CrmSSOAccountId": "sample string 4",
"PageName": "sample string 5",
"Id": "sample string 6",
"TabName": "sample string 7",
"Type": "sample string 8",
"ViewAsClient": true
}
application/xml, text/xml
Sample:
<SsoModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tamarac.Advisor.AdvisorApi.Models"> <AppCode>sample string 2</AppCode> <CrmSSOAccountId>sample string 4</CrmSSOAccountId> <Id>sample string 6</Id> <PageName>sample string 5</PageName> <PartyCode>sample string 3</PartyCode> <TabName>sample string 7</TabName> <Type>sample string 8</Type> <UserId>sample string 1</UserId> <ViewAsClient>true</ViewAsClient> </SsoModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The URL of the SSO Destination
stringResponse Formats
application/json, text/json
Sample:
"sample string 1"
application/xml, text/xml
Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>