You need the Manage Settings permission to manage visitor sso config.
Visitor Single Sign-On (SSO) is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
isEnabled |
bool | Whether visitor single sign-on (SSO) is enabled or not. |
signInUrl |
string | Url for sign-in. |
logoutUrl |
string | Url for log-out. |
artifactResolutionServiceUrl |
string | Url for artifact resolution service. |
samlCertificate |
string | SAML certificate, mandatory when type is SAML. |
jwtLogoutUrl |
string | |
jwtLoginUrl |
string | |
jwtCertificate |
string | |
protocolType |
string | Allowed values are "samlSso", "jwtSso". |
visitorSsoFieldMappings |
visitorSsoFieldMappings[] | Reference to LiveChat_VisitorSsoFieldMapping. |
visitorSsos |
visitorSsos[] | Reference to Campaign Visitor SSO. |
LiveChat_VisitorSsoFieldMapping JSON Format:
Name | Type | Description |
---|---|---|
id |
guid | Id of the visitor sso field mapping. |
idpAttribute |
string | SSO attribute name from Idp. |
comm100Field |
string | The Comm100 field name. |
Campaign Visitor SSO JSON Format:
Name | Type | Description |
---|---|---|
campaignId |
guid | Id of the campaign. |
signInOption |
string | Allowed values are "noSignIn", "signInOptional", "signInRequired". |
isPreChatFormSkipped |
bool | Whether pre-chat form is skipped or not. |
ifOpenLoginPageInEmbeddedChatWindow |
bool | Whether to open the login page in embedded chat window or not. |
campaign |
campaign | Reference to Campaign. |
GET livechat/visitorSsoConfig
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed values are "visitorSsoFieldMapping", "campaignVisitorSso". |
Sample Request:
Response:
HTTP/1.1 200 OK
POST livechat/visitorSsoConfig:disable
Sample Request:
Response:
HTTP/1.1 200 OK
POST livechat/visitorSsoConfig:enable
Sample Request:
Response:
HTTP/1.1 200 OK
PUT livechat/visitorSsoConfig
Name | Type | In | Required | Description |
---|---|---|---|---|
isEnabled |
bool | body | no | Whether visitor single sign-on (SSO) is enabled or not. |
signInUrl |
string | body | yes | Url for sign-in. |
logoutUrl |
string | body | no | Url for log-out. |
artifactResolutionServiceUrl |
string | body | no | Url for artifact resolution service. |
samlCertificate |
string | body | no | SAML certificate, mandatory when type is SAML. |
jwtLogoutUrl |
string | body | no | |
jwtLoginUrl |
string | body | no | |
jwtCertificate |
string | body | yes | |
protocolType |
string | body | yes | Allowed values are "samlSso", "jwtSso". |
visitorSsoFieldMappings |
visitorSsoFieldMappings[] | body | no | All the existing mapping should be included with this endpoint, otherwise the excluded ones will be deleted. |
visitorSsos |
visitorSsos[] | body | no | Reference to Campaign Visitor SSO. |
Sample Request:
Response:
HTTP/1.1 200 OK