[Index]
Model: data/HcsSpMetadataDAT
SSO SP Metadata
To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com
This procedure configures self-service Single Sign-On (SSO) for VOSS-4-UC.
The configuration applies to customers and customer administrators associated
with the identify provider (IdP).
Note
Administrators are configured for SSO use via the Users form (default menu
User Management > Users).
Prerequisites
- Create a self-signed or third-party-signed system certificate. For more
information, see SSO Certificate Management.
- The VOSS-4-UC server and the IdP server must be configured so that their
clocks are synchronized.
SSO Service Provider Configuration
Log in to VOSS-4-UC as system administrator.
Choose Single Sign On > SSO SP Settings.
Note
This screen is only available to you if you've logged in as a higher-level
administrator.
Click Add.
Note
Configure only one instance of SSO SP Settings.
On the Base tab:
- (Mandatory). From the System Certificate drop-down, choose the System Certificate
to use. See SSO Certificate Management.
- To allow the SSO SP Setting to expire, enter a number of hours in
the Validity (Hours) field.
Note
- Specifying an unsigned third-party-signed certificate results in an error.
- To renew an expired certificate, see Renew Single Sign-On Certificate for VOSS-4-UC.
On the SAML SP Settings tab:
- Enter the mandatory FQDN of the Server.
- Select the Sign Authn Requests and Want Assertions Signed check boxes
as required by your security environment.
Note
- Only select Want Reponse Signed if you're sure that all IdPs sign responses.
- If a secure connection is required with the secure attribute set on the
cookies, the URL values for bindings of End Points must be specified with https.
Click Save.
To view the location of the VOSS-4-UC SP metadata that you will upload to the
IdP:
- Choose Single Sign On > SSO SP Metadata.
- Point your browser to the URL shown here, and then save a copy of the SP metadata.
Upload the SP metadata to the IdP.
Refer to your IdP documentation for details on adding VOSS-4-UC as a service provider.
Note
The IdP must release the UID and map it to an appropriate attribute. For
example, an IdP that authenticates with Active Directory can map the uid
SAML attribute to sAMAccountName in the Active Directory server.
Download the IdP metadata from the IdP server.
Refer to your IDP documentation for details on downloading IDP metadata.
Note
If an expired SSO certificate is being renewed and the IdP metadata has not changed,
the download, configure and upload of the IdP metadata is not required.
Integrating with an SSO Identity Provider
Log in as provider, reseller, or customer administrator (depending on your
IdP configuration level).
Choose Administration Tools > File Management and upload the IdP metadata.
Choose Single Sign On > SSO Identity Provider.
Click Add to add the SSO Identity Provider configuration.
Note
Only one instance of an SSO Identity Provider can be configured for a hierarchy node.
On the SSO Identity Provider screen, complete at least the mandatory fields (Entity ID,
Login URI, Local Metadata File, User lookup fieldat minimum, the mandatory SSO
Identity Provider fields (see SSO Identity Provider fields):
If a customer is using a custom domain, the Service Provider Domain Name
is filled in at the hierarchy level and the login and metadata URLs used
will be tied to the IdP as follows:
SSO Login URL: ``https://<Service Provider Domain Name>/sso/<Login URI>/login``
Admin Portal: ``https://<Service Provider Domain Name>/admin/sso/<Login URI>/login``
Business Admin Portal: ``https://<Service Provider Domain Name>/business-admin/sso/<Login URI>/login``
The metadata is obtained from: https://<Service Provider Domain Name>/sso/<Login URI>/metadata
If the Service Provider Domain Name is specified, the metadata XML file from
VOSS-4UC then contains Service.Provider.Domain.Name in the assertion
consumer service URL as shown in the example below:
<md:AssertionConsumerService
Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
Location="https://Service.Provider.Domain.Name/sso/acs/"
index="1"/>
This metadata needs to be uploaded to the IdP (not the generic metadata
obtained from SSO Service Provider Configuration).
Important
If you have previously uploaded metadata to the IDP and you subsequently
complete this Service Provider Domain Name field,
you need to remove the previous record from
the IDP and re-upload the metadata so that it contains this field.
Click Save to save the SSO Identity Provider Configuration and enable
SSO if selected.
Choose User Management > Users and filter on Auth Method equals SSO to display enabled SSO users.
When the Service Provider Domain Name is not specified for a given IDP,
these URLs are used for SSO login:
SSO Login URL: ``https://<FQDN of the Service Provider>/sso/<login_URI>/login``
Admin Portal: ``https://<FQDN of the Service Provider>/admin/sso/<Login URI>/login``
Business Admin Portal: ``https://<FQDN of the Service Provider>/business-admin/sso/<Login URI>/login``
See SAML SP Settings FQDN in SSO Service Provider Configuration.
The IdP redirects to this FQDN on login.
Note
While an IdP may exist at more than one hierarchy in VOSS-4-UC,
a user will only be permitted to log in if the user exists at or below
the hierarchy of a single IdP.
SSO Identity Provider: Field Reference
System Message: ERROR/3 (<string>, line 175)
Malformed table.
+----------------------+------------------------------------------------------------------------------+
| Field | Description |
+======================+==============================================================================+
| | Mandatory. Entity ID of the IDP. This field must exactly match the |
| Entity Id | entity ID in the IdP metadata file. |
| | |
+----------------------+------------------------------------------------------------------------------+
| | Mandatory. Login URI for the IDP. This is the URI that |
| Login URI | will be embedded in SSO Login URL. It can |
| | contain only alphanumeric characters and |
| | forward slashes. |
+----------------------+------------------------------------------------------------------------------+
| Service Provider | The FQDN that will be embedded in the SP metadata for this |
| Domain Name | IdP for URLs that refer back to the Service Provider. |
+----------------------+------------------------------------------------------------------------------+
| Local Metadata | Mandatory. Choose the IdP metadata file. This field |
| File | must be unique across the system. |
+----------------------+------------------------------------------------------------------------------+
| | Select the check box to enable SSO for users synced in or |
| SSO Enabled | created at the current hierarchy level. |
| | Clear this check box to disable SSO for |
| | the users associated with the defined IDP. |
+----------------------+------------------------------------------------------------------------------+
| Note | Reminder to upload the IdP metadata file |
+----------------------+------------------------------------------------------------------------------+
| SSO Login URL | Read-only field displays the SSO Login URL to use. |
+----------------------+------------------------------------------------------------------------------+
| Business Admin | Read-only. Displays the Business Admin Portal SSO Login URL to use. |
| Portal Login URL | |
+----------------------+------------------------------------------------------------------------------+
| Admin Portal Login | Read-only. Displays the new Admin Portal SSO Login URL to use. |
| URL | |
+----------------------+------------------------------------------------------------------------------+
| User lookup field | Mandatory. Select the field to bind the VOSS and SSO user - typically |
| | ``username``. |
+----------------------+------------------------------------------------------------------------------+
| Authentication Scope | Hierarchical scope this server applies to. |
| | |
| | * Full tree authentication (default): |
| | All nodes at and below this node in its tree can authenticate against |
| | this server. |
| | * Local authentication: |
| | Only users at this node can authenticate against this server. See |
| | User Login Options by Authentication Method and Server Authentication Scope. |
+----------------------+------------------------------------------------------------------------------+
| User sync type | Type of users that can authenticate against this server. |
| | |
| | * Synced users only: Only users synced in from LDAP can authenticate against |
| | this server. |
| | * All users |
+----------------------+------------------------------------------------------------------------------+
HcsSpMetadataDAT
Model Details: data/HcsSpMetadataDAT
- An asterisk * in the title indicates the field is mandatory.
- If a field has a default value, it is shown in the Description column.
- If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
- Object and array field names are listed to provide context. If a field belongs to an object or an array,
the full field name is shown in dot separated notation.
|
Note
|
|
- Field Name:
note
- Type: String
- MaxLength: 1024
|
|
Metadata URL
|
The URL to SSO SP metadata
|
- Field Name:
md_url
- Type: String
- MaxLength: 1024
|