SiteWorx supports SAML Single Sign-On (SSO) using both Identity Provider and Service Provider initiated flows. There are a few steps that both the end user IT department & SiteWorx Support must complete to enable SSO on your SiteWorx instance.
Configuration
Within your Identity Provider (IdP), set up the following:
Assertion Attributes
Field
Required?
Example
email
Yes
"JohnDoe@example.com"
first_name
No
"John"
last_name
No
"Doe"
phone
No
phone_country_code
No
"1"
phone_number_verified
No
"true" , "false"
locale
No
“en”, “de”, “es”, “fr”
siteworx
Yes
"user" - standard user
“admin” - org admin
“” - not approved for SiteWorx (deny access)
Additional attributes are available to provide more granular access control, contact us for further information
When prompted for <organization>, enter the subdomain of your custom URL: organization.siteworx.io
Using https://acmecorporation.siteworx.io as an example, the ACS would be https://acmecorporation-backend.siteworx.io/api/v1/sso/saml2/organizations/acmecorporation/callback and the SP Entity ID would be https://acmecorporation-backend.siteworx.io.
After the IdP is configured, send a metadata.xml file or metadata URL to SiteWorxOps@siteworx.io with relevant information about your SiteWorx account (such as company name and organization).
FAQs
Does SiteWorx support granular user permissions restricting user access to specific sites?
Yes, granular user permissions can be accomplished using the siteworx assertion attribute. Please contact SiteWorxOps@siteworx.io for guidance on granular user permissions.
My organization uses a different authorization protocol. Does SiteWorx support it?
Currently, SiteWorx supports SAML and OIDC SSO; please contact SiteWorxOps@siteworx.io to explore alternative authorization protocols.
Does SiteWorx support Single Log-Out?
Yes, SiteWorx can support Single Log-Out (SLO) upon request.
Are assertion attributes are case sensitive?
Yes, assertion attributes are case sensitive. The attribute name must be lowercase. Attributes with pre-defined values (phone_number_verified, locale and siteworx) must have lowercase values that match the values noted in the table.
Resellers have access to an online tool to check gateway connectivity status for newly connected gateways. This is a helpful tool to confirm IT departments have configured ports correctly before traveling onsite for commissioning, or requesting ...
Overview Since it's possible to connect multiple light fixtures to a single SCN or DLA sensor, Commissioner needs to understand what type of device(s) is (are) being controlled and metered. This step in commissioning is broadly referred to as ...
Use this tool to update firmware on a device. SiteWorx subscribers receive automatic firmware updates. Do not perform a firmware update unless directed to do so by SiteWorx Support. Note: To update the firmware, the version must be newer than the ...
The Commissioner application, installed locally on a laptop, is used by system installers for the initial setup of a new SiteWorx facility. Commissioner, in conjunction with a USB wireless adapter (DLUSB), is used to wirelessly program lighting and ...
Access the Menu at the top of Commissioner. File New — Create a new map file Open — Open and edit an existing map file Tip: When you launch Commissioner, the most recently edited map file loads automatically Merge — Merge one map file into another ...