Visitor Single Sign-On (SSO)

You need the Manage Settings permission to manage visitor sso config.

Visitor Single Sign-On (SSO)
- Visitor Single Sign-On (SSO) Manage
GET livechat/visitorSsoConfig
POST livechat/visitorSsoConfig:disable
POST livechat/visitorSsoConfig:enable
PUT livechat/visitorSsoConfig
Model
Visitor Single Sign-On (SSO) JSON Format

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.
Endpoint
Get a single Visitor Single Sign-On (SSO)

GET livechat/visitorSsoConfig

Parameters:
Name Type In Required Description
include string query no Allowed values are "visitorSsoFieldMapping", "campaignVisitorSso".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/visitorSsoConfig \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"isEnabled":true,"signInUrl":"https://autoportal.comm100dev.io/SSOIDP","logoutUrl":"","artifactResolutionServiceUrl":"","samlCertificate":"","jwtLogoutUrl":"","jwtLoginUrl":"","jwtCertificate":"","protocolType":"","visitorSsoFieldMappings":[{"id":"FFE0FD0E-81A5-4998-81FD-E01DAA2D4ABD","idpAttribute":"phone","comm100Field":"{!Pre-Chat.Phone}"}],"visitorSsos":[{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","signInOption":"noSignIn","isPreChatFormSkipped":true,"ifOpenLoginPageInEmbeddedChatWindow":true,"campaign":{"name":"Temporary Campaign","id":"E7B4BD07-C09D-4252-856E-49CA22537B94","description":"This is a campaign for testing","language":"english"}}]}
Disable the Visitor Single Sign-On (SSO)

POST livechat/visitorSsoConfig:disable

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/visitorSsoConfig:disable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"isEnabled":false,"signInUrl":"https://autoportal.comm100dev.io/SSOIDP","logoutUrl":"","artifactResolutionServiceUrl":"","samlCertificate":"","jwtLogoutUrl":"","jwtLoginUrl":"","jwtCertificate":"","protocolType":"","visitorSsoFieldMappings":[{"id":"FFE0FD0E-81A5-4998-81FD-E01DAA2D4ABD","idpAttribute":"phone","comm100Field":"{!Pre-Chat.Phone}"}],"visitorSsos":[{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","signInOption":"noSignIn","isPreChatFormSkipped":true,"ifOpenLoginPageInEmbeddedChatWindow":true,"campaign":{"name":"Temporary Campaign","id":"E7B4BD07-C09D-4252-856E-49CA22537B94","description":"This is a campaign for testing","language":"english"}}]}
Enable the Visitor Single Sign-On (SSO)

POST livechat/visitorSsoConfig:enable

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/visitorSsoConfig:enable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"isEnabled":true,"signInUrl":"https://autoportal.comm100dev.io/SSOIDP","logoutUrl":"","artifactResolutionServiceUrl":"","samlCertificate":"","jwtLogoutUrl":"","jwtLoginUrl":"","jwtCertificate":"","protocolType":"","visitorSsoFieldMappings":[{"id":"FFE0FD0E-81A5-4998-81FD-E01DAA2D4ABD","idpAttribute":"phone","comm100Field":"{!Pre-Chat.Phone}"}],"visitorSsos":[{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","signInOption":"noSignIn","isPreChatFormSkipped":true,"ifOpenLoginPageInEmbeddedChatWindow":true,"campaign":{"name":"Temporary Campaign","id":"E7B4BD07-C09D-4252-856E-49CA22537B94","description":"This is a campaign for testing","language":"english"}}]}
Update the Visitor Single Sign-On (SSO)

PUT livechat/visitorSsoConfig

Parameters:
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.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/visitorSsoConfig \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"isEnabled":true,"signInUrl":"https://autoportal.comm100dev.io/SSOIDP","logoutUrl":"","artifactResolutionServiceUrl":"","samlCertificate":"","jwtLogoutUrl":"","jwtLoginUrl":"","jwtCertificate":"","protocolType":"","visitorSsoFieldMappings":[{"idpAttribute":"phone","comm100Field":"{!Pre-Chat.Phone}"}],"visitorSsos":[{"signInOption":"noSignIn","isPreChatFormSkipped":true,"ifOpenLoginPageInEmbeddedChatWindow":true}]}'

Response:

 HTTP/1.1 200 OK

{"isEnabled":true,"signInUrl":"https://autoportal.comm100dev.io/SSOIDP","logoutUrl":"","artifactResolutionServiceUrl":"","samlCertificate":"","jwtLogoutUrl":"","jwtLoginUrl":"","jwtCertificate":"","protocolType":"","visitorSsoFieldMappings":[{"id":"FFE0FD0E-81A5-4998-81FD-E01DAA2D4ABD","idpAttribute":"phone","comm100Field":"{!Pre-Chat.Phone}"}],"visitorSsos":[{"campaignId":"22f0b296-69e9-4b81-abe4-4bb9ed5ec9ef","signInOption":"noSignIn","isPreChatFormSkipped":true,"ifOpenLoginPageInEmbeddedChatWindow":true,"campaign":{"name":"Temporary Campaign","id":"E7B4BD07-C09D-4252-856E-49CA22537B94","description":"This is a campaign for testing","language":"english"}}]}