Difficulty: expert
Content
Table of Contents | ||||
---|---|---|---|---|
|
Learning Objectives
After reading this article, you’ll be able to:
Configure SSO for Workplace Management
The configuration guides for configuring in your Single Sign On application can be found below.
SSO implementation on the side of Workplace Management is currently still always done by the Spacewell Integration team.
Expand | ||
---|---|---|
| ||
Below you will find the necessary steps to create a Single sign on application inside the Azure AD portal. Creating Azure applicationIn Azure AD, navigate to Enterprise applications Press on “New Application” Press on “Create your own application” Fill in a suitable name and select the option “ Integrate any other application you don't find in the gallery (Non-gallery)“. After that, click on “Create” It might take some time for the application to be created. Azure will provide you will the following message until it is ready Setting up single sign onOnce the application is created and you are navigated to the application properties screen, click on “Set up single sign on” or do this in the menu on the left with “Single sign-on” Select the “SAML” option Automatic using metadata fileThe easiest way to fill in the single sign on settings is through the metadata file. This can be acquired in two ways:
Once you have the URL, make sure to save the XML to your computer. If you would like to manually setup the necessary settings, you can retrieve these values from the metadata. We will not provide documentation for a manual setup, as we suspect the necessary knowledge is available to you if you decide to select this option. Be aware: when making the decision for a manual setup, Spacewell might charge you for any assistance that might be necessary from a Spacewell consultant. Uploading the metadataIn Azure, click on “Upload metadata file” Select the XML that you have just saved to your computer and press on “Add” As a result, you should be presented with a “Basic SAML Configuration” page. In this you can find the pre-filled values from the metadata file. One value that you can add is the “Sign on URL (Optional)”. Using this value will allow Service Provider Initiated Single Sign On. This is not necessary, but is advised to fill in. In most cases, this URL should be the following: https://client.axxerion.com/axxerion/sso Where you replace “client” with your client specific URL that you should already be familiar with. Be aware that Workplace Management supports multiple SSO connections within one client environment. If that is the case, this URL will be different and should be discussed with your Spacewell contact. Once you have entered the necessary values, press “Save”. Once saved successfully, close the configuration screen. Azure might prompt you to test the connection. Decline this offer, as several settings still need to be set (both in Azure as well as on the Workplace Management end). Setting additional claims (optional)If you intend to use the SSO connection in combination with Just In Time Provisioning, you might want to add additional claims. To do this, navigate to “Attributes & Claims” and press “Edit” In the resulting screen, you can add any (group) claims if preferred. If you need further assistance adding these, please consult with your Azure administrator on how to add these. Adding usersIn the menu on the left, click on “Users and groups” Press on “Add user/group” Press on “None selected” and search for either the users or a specific group that you would like to give access to the Single sign on application. Press on “Select” to add the users and/or groups Press on “Assign” to assign the users to the application Any other changes to the users and/or groups should be done by the Azure administrator from your end. Sharing the necessary informationIf you are done with all the above steps, you can share the metadata file from the application with your Spacewell contact. On the SAML-based Sign-on page, navigate to section 3 “SAML Certificates” and share the “App Federation Metadata Url” with your Spacewell contact. They will take the necessary steps on their end to allow the SSO connection to work. Certificate renewalsEvery year, Workplace Management will update the certificate that is used for the SSO connection. Currently, Azure will accept this certificate without any necessary steps from your end being necessary. In case the certificate is renewed on the Azure end, Spacewell should be notified of this as soon as possible through the necessary support channels. Having provided Spacewell with the Federation Metadata URL will allow a Spacewell contact to easily update the necessary settings on the Workplace Management end. Should Spacewell not be notified, the SSO connection will cease to function once the certificate on the end of Azure expires. |
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Okta Configuration GuideBelow you will find the necessary steps to create a Single sign on application inside the Okta portal. Creating Okta SSO applicationIn Okta, navigate to “Applications > Applications” and press on “Create App Integration” In the modal, please select “SAML 2.0” and click on “Next” Fill in an “App name” and press on “Next”. You are free to check any of the “App visibility” options if they apply to you. Also, you do not need to add anything for the App logo as this application will not be used to be presented to your users (more on this in the “Creating Okta Bookmark application” section) Metadata informationThe easiest way to retrieve the information necessary for the SAML 2.0 connection is through the metadata file. This can be acquired in two ways:
Once you have the URL, you can open this in your browser. If so inclined, you can also download the file and open it in your favorite text editor. In the below table, you can find the mapping with in the first column the field in the Okta application and in the second column the tag name in the XML from the Workplace Management Federation Metadata.
Scroll down to the “Attribute Statements (optional)” and add the attributes that should be shared. As a minimal, you should add “user.email”, “user.firstName” and “user.lastName”. Take note of the values in the column “Name”, as those need to be shared with your Spacewell contact. Use the “Add Another” button to add additional attributes if you need those. Press on “Next” In the next screen, set the value to “I’m an Okta customer adding an internal app” and “This is an internal app that we have created”. Than press on “Finish” In the resulting screen, navigate to the section “SAML Signing Certificates”. Click on the active certificate and press “Actions”, followed with “View IdP metadata”. A tab should open with the necessary Metadata URL. Make note of the URL and share this with your Spacewell contact. Creating Okta Bookmark application (optional)If you would like users to login from Okta into Workplace Management, you will need to make a bookmark application. The SSO application in Okta does not allow a URL to be specified with which a user can login. Adding a bookmark application does make this possible. In Okta, click on “Applications > Applications” followed by “Browse App Catalog” Search for “Bookmark” in the search bar and select the “Bookmark App” Click on “Add Integration” Fill in an “Application Label” and the “URL”. In most cases, the URL value should be the following: https://client.axxerion.com/axxerion/sso Where you replace “client” with your client specific URL that you should already be familiar with. Be aware that Workplace Management supports multiple SSO connections within one client environment. If that is the case, this URL will be different and should be discussed with your Spacewell contact. Press on “Done” when you are ready Assign usersAssigning users applies to at least the SSO application and optionally the bookmark application. Open the application and go to the “Assignments” tab. Click on “Assign” and select if you would like to add People or Groups In the below example, we will add one specific user. Select the users that you would like to add and press “Assign”. Once assigned, press “Done” Your users should be visible in the application Add application logo (optional)If you would like to add a logo to either application, you can download the Workplace Management logo below. Press on the logo and the image should be enlarged. You can download it by pressing the “Download” icon on the top right. Open the application and press on the “pen” icon near the existing logo (most likely the cog) Then select the downloaded image and press on “Update Logo” Certificate renewalsEvery year, Workplace Management will update the certificate that is used for the SSO connection. Currently, Okta will accept this certificate without any necessary steps from your end being necessary. In case the certificate is renewed on the Okta end, Spacewell should be notified of this as soon as possible through the necessary support channels. Having provided Spacewell with the Federation Metadata URL will allow a Spacewell contact to easily update the necessary settings on the Workplace Management end. Should Spacewell not be notified, the SSO connection will cease to function once the certificate on the end of Okta expires. |
Expand | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Below you can find the settings that, if used, will lead to a successful SAML connection with Workplace Management. These settings have lead to the most successful connections with clients. Deviating from the below settings might cause billable hours by your Spacewell contact. Settings in ADFSThroughout the images below, you will find references to the server “axpr05”. This should be replaced with your Workplace Management server. You can find this information in Retrieving Federation Metadata URL for Workplace Management Setup the necessary claims
Custom claimThe custom claim that is used above is setup as follows:
Custom claims in case the above does not workIn the rare case that the above instruction is not sufficient for a working connection, the following custom claims might need to be implemented. All the other claims should be removed. Custom claim 1
Custom claim 2
|
Expand | ||
---|---|---|
| ||
Inside Workplace Management, navigate to the environment setup by clicking on the “Setup” dashboard button or in the menu on “Admin > Setup”. Take note of the server number The metadata URL can be found by using the following URL: https://axpr00.axxerion.com/axxerion/saml/metadata In this URL, you should replace the 00 with your server number. Be aware: if you are on a server with a single digit, it should be axpr01. |
Summary
Rw ui textbox macro |
---|
Exercise
- N/A
Search
Live Search |
---|