{"id":22339,"date":"2024-02-15T14:48:40","date_gmt":"2024-02-15T22:48:40","guid":{"rendered":"https:\/\/docs.extraview.com\/v22\/book\/sso-connections\/"},"modified":"2024-02-15T14:48:40","modified_gmt":"2024-02-15T22:48:40","slug":"sso-connections","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v22\/sso-connections\/","title":{"rendered":"SSO Connections"},"content":{"rendered":"<p>The Single Sign On facility allows another application to control user access to ExtraView. When this is enabled through ExtraView\u2019s behavior settings (see above), the SSO application is entirely responsible for the authentication of each user. Once the authentication is complete, the SSO application forwards the authenticated information to ExtraView, and ExtraView automatically signs on the user. If necessary, and subject to any licensing restrictions, a new user will be created within ExtraView.<\/p>\n<p>When ExtraView is configured to use SSO as the user authentication mechanism, the user points their browser to the SSO sign on page. ExtraView extracts the user ID and other pertinent data from the HTTP request header and automatically logs the user into ExtraView \u2013 no ExtraView sign on page is displayed. During the sign on process, ExtraView will access all of the user\u2019s information in the LDAP Server, assuming this is configured. A new ExtraView user will be created, if the user does not exist. If the user exists in the ExtraView database, their record is updated to ensure synchronization with the LDAP server.<\/p>\n<h3>\n\tSSO Header Mapping<\/h3>\n<p>The \u201clogin\u201d HTTP header from SSO contains the authenticated user\u2019s information. ExtraView administrative data held in the security_user table defines the headers that are used by ExtraView and where in ExtraView each field is stored. All of these fields map to the individual fields that contain user data. This mapping is used in conjunction with the LDAP user data, bypassing the need for an administrator to add a new user specifying this information.<\/p>\n<p>In the ExtraView configuration file (<span class=\"fixedWidthfont\">Configuration.properties<\/span>), these fields are mapped to match the host header data as shown in the following example:<\/p>\n<table>\n<tbody>\n<tr>\n<td>\n\t\t\t\t<span class=\"fixedWidthFont\">#############################<br \/>\n\t\t\t\t## SSO HEADER MAPPING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ##<br \/>\n\t\t\t\t#############################<br \/>\n\t\t\t\tSSO_PRIMARYKEY&nbsp; = USER_NAME<br \/>\n\t\t\t\tSSO_SURNAME&nbsp;&nbsp;&nbsp;&nbsp; = SURNAME<br \/>\n\t\t\t\tSSO_GIVENNAME&nbsp;&nbsp; = GIVEN_NAME<br \/>\n\t\t\t\tSSO_EMAIL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; = EMAIL_ADDRESS<br \/>\n\t\t\t\tSSO_STREET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; = STREET<br \/>\n\t\t\t\tSSO_CITY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; = CITY<br \/>\n\t\t\t\tSSO_STATE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; = STATE<br \/>\n\t\t\t\tSSO_POSTALCODE&nbsp; = POSTALCODE<br \/>\n\t\t\t\tSSO_COUNTRY&nbsp;&nbsp;&nbsp;&nbsp; = COUNTRY<br \/>\n\t\t\t\tSSO_PHONE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; = TELEPHONE_NUMBER<br \/>\n\t\t\t\tSSO_MOBILE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; = MOBILE_NUMBER<br \/>\n\t\t\t\tSSO_PAGER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; = PAGER_NUMBER<br \/>\n\t\t\t\tSSO_COMPANYNAME = COMPANYNAME<\/span><br \/>\n\t\t\t\t&nbsp;<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>As well as the fields such as USER_NAME and CITY in the example above, you can also map the user defined fields in the ExtraView security_user table. There are five of those, named USER_FIELD_1 through USER_FIELD_5.<\/p>\n<p><strong>Notes:<\/strong><\/p>\n<ol>\n<li>\n\t\tIf SSO_COMPANYNAME is configured AND it has a non-blank value in the header, it will always use that in creating\/updating the user<\/li>\n<li>\n\t\tIf SSO_COMPANYNAME is not configured or it has a null\/blank value in the header, the app default COMPANY_NAME will be used to create\/update the user<\/li>\n<li>\n\t\tThe user&#8217;s company name is not used to compare the existing user with the request to sign on a user<\/li>\n<li>\n\t\tIf the SSO_UPSERT behavior setting is set to a value of YES, then the setting LDAP_UPSERT should always be set to a value of NO<\/li>\n<\/ol>\n<h3>\n\tThe SSO_DN_USER_ID_ATTRIBUTE<\/h3>\n<p><span class=\"fixedWidthFont\">SSO_DN_USER_ID_ATTRIBUTE<\/span> &#8211; short for Distinguished Name User ID Attribute &#8211; indicates two behaviors:<\/p>\n<ol>\n<li>\n\t\tThe SSO header is in Distinguished Name format, e.g., <span class=\"fixedWidthFont\">cn=abc,dn=def,ou=ghi<\/span><\/li>\n<li>\n\t\tThe attribute of the user ID within the DN is the value of the SSO_DN_USER_ID_ATTRIBUTE followed by an optional instance number.. For example, if SSO_DN_USER_ID_ATTRIBUTE=cn, then the user ID would be <span class=\"fixedWidthFont\">abc<\/span> based on the example in the previous point.<\/li>\n<\/ol>\n<p>Another example is:<\/p>\n<p><span class=\"fixedWidthFont\">cn=2055092,cn=Users,dc=dsd,dc=fmcna,dc=com<\/span><\/p>\n<p>In this case, <span class=\"fixedWidthFont\">SSO_DN_USER_ID_ATTRIBUTE=cn<\/span> would still work to establish 2055092 as the user_id.<\/p>\n<p>If the DN is:<\/p>\n<p><span class=\"fixedWidthFont\">cn=Users,cn= 2055092,dc=dsd,dc=fmcna,dc=com<\/span><\/p>\n<p>then the <span class=\"fixedWidthFont\">SSO_DN_USER_ID_ATTRIBUTE=cn#2<\/span> would establish the <span class=\"fixedWidthFont\">2055092<\/span> as the <span class=\"fixedWidthFont\">user_id<\/span> (the <span class=\"fixedWidthFont\">#2<\/span> indicates that the second instance of the attribute should be used). Note that <span class=\"fixedWidthFont\">cn#1<\/span> and <span class=\"fixedWidthFont\">cn<\/span> act the same when used as configuration values for SSO_DN_USER_ID_ATTRIBUTE.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>The Single Sign On facility allows another application to control user access to ExtraView. When this is enabled through ExtraView\u2019s behavior settings (see above), the SSO application is entirely responsible for the authentication of each user. Once the authentication is complete, the SSO application forwards the authenticated information to ExtraView, and ExtraView automatically signs on&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-22339","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v25.1 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>SSO Connections - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v22\/sso-connections\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"SSO Connections - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"The Single Sign On facility allows another application to control user access to ExtraView. When this is enabled through ExtraView\u2019s behavior settings (see above), the SSO application is entirely responsible for the authentication of each user. Once the authentication is complete, the SSO application forwards the authenticated information to ExtraView, and ExtraView automatically signs on...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v22\/sso-connections\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/sso-connections\/\",\"url\":\"https:\/\/docs.extraview.com\/v22\/sso-connections\/\",\"name\":\"SSO Connections - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/#website\"},\"datePublished\":\"2024-02-15T22:48:40+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/sso-connections\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v22\/sso-connections\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/sso-connections\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v22\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"SSO Connections\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v22\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v22\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v22\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v22\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v22\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"SSO Connections - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v22\/sso-connections\/","og_locale":"en_US","og_type":"article","og_title":"SSO Connections - Product Documentation","og_description":"The Single Sign On facility allows another application to control user access to ExtraView. When this is enabled through ExtraView\u2019s behavior settings (see above), the SSO application is entirely responsible for the authentication of each user. Once the authentication is complete, the SSO application forwards the authenticated information to ExtraView, and ExtraView automatically signs on...","og_url":"https:\/\/docs.extraview.com\/v22\/sso-connections\/","og_site_name":"Product Documentation","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v22\/sso-connections\/","url":"https:\/\/docs.extraview.com\/v22\/sso-connections\/","name":"SSO Connections - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v22\/#website"},"datePublished":"2024-02-15T22:48:40+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v22\/sso-connections\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v22\/sso-connections\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v22\/sso-connections\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v22\/"},{"@type":"ListItem","position":2,"name":"SSO Connections"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v22\/#website","url":"https:\/\/docs.extraview.com\/v22\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v22\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v22\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v22\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v22\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v22\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v22\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v22\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/pages\/22339","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/comments?post=22339"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/pages\/22339\/revisions"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v22\/wp-json\/wp\/v2\/media?parent=22339"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}