Automating user management (IdP)
Last updated 2023-06-09
IMPORTANT
This guide only applies to Next-Gen WAF customers with access to the Next-Gen WAF control panel.
An identity provider (IdP) is a system that stores and manages users' digital identities. We support automated user management through Okta.
Provisioning users via Okta enables you to automatically synchronize user access to your sites (also known as workspaces) and their specific permission levels (also known as roles) for those sites (workspaces). Specifically, you can:
- Push new users. New users created through Okta can be created in the Next-Gen WAF.
- Push profile updates. Updates made to the user's profile through Okta can be pushed to the Next-Gen WAF.
- Push user deactivation and reactivation. Deactivating the user or disabling the user's access to the application through Okta will delete the user in the third party application. Reactivating the user in Okta will recreate the user.
Limitations and considerations
When using Okta as your IdP, keep the following things in mind:
- A user that is provisioned by Okta can only be modified or deleted inside of Okta.
- The Next-Gen WAF only accepts email addresses with letters that are lowercase. Email addresses with uppercase letters will result in erroneous behavior.
- If an existing user has the same email address as a user being provisioned within Okta, the accounts will be consolidated. Users won’t have to be re-provisioned upon setup, but the new group assignments will override existing role and permissions.
Prerequisites
Before configuring the IdP, complete the following prerequisites:
- In your Next-Gen WAF account, enable single sign-on to use Okta as your SSO provider.
- In Okta, create an integration with Next-Gen WAF if you do not already have one. Follow the instructions listed in the Okta application, which provides specific configuration information.
- Using our API, create an API Access Token in the Next-Gen WAF and store it in a secure location for use later in this guide.
Configuring the IdP
To configure automated user management through Okta, follow these steps.
Enter configuration information
On the Provisioning tab of the Signal Sciences Okta application, enable provisioning by entering the following information:
SCIM connector base URL: Enter
https://dashboard.signalsciences.net/api/v0/corps/<corpname>/scim/v2
where<corpname>
is the “name” of your Corp.- Your
<corpname>
is present in the address of your Next-Gen WAF control panel, such ashttps://dashboard.signalsciences.net/corps/<corpname>/overview
. - Your
<corpname>
can also be retrieved from the List Corps API endpoint.
- Your
Unique identifier field for users: Select Email.
Supported provisioning actions: Select Push New Users and Push Profile Updates.
Authentication Mode: Select HTTP Header.
Authorization: Generate a Bearer Token from the API Access Token you generated earlier. The Bearer Token is created by base64 encoding a string composed of the email address associated with your user, a colon, and the API Access Token you generated.
An example command for creating a Bearer Token in bash:
$ echo -n "user@example.com:c9e4bbc5-a5c4-19d3-b31f-691d8b2139fe" | base64An example command for creating a Bearer Token in JavaScript:
btoa("<signal_sciences_email>:<signal_sciences_access_token>") = "YW5keUBleGFtcGxlY29ycC5jb206ZXhhbXBsZXRva2Vu"
Test configuration
Confirm your connection was configured correctly by clicking Test Connector Configuration. If everything is configured correctly, you will see "Signal Sciences was verified successfully!":
Click Save to save this configuration and proceed.
Enable provisioning features
After the settings are saved, select Enable for the following under Provisioning to App:
- Create Users
- Update User Attributes
- Deactivate Users
Click Save to save these settings and proceed.
After enabling provisioning, you may see a message that unmapped attributes exist on the application. This will not prevent provisioning; however, if you wish to map Next-Gen WAF attributes to your base Okta user profile, you may do so by mapping the following attributes:
userType
should be mapped onto a string attribute that will represent the user'srole
. The value of this must be a validrole
:owner
,admin
,user
, orobserver
.entitlements
should be mapped onto a string array attribute that will represent the user'ssites
. This should be set to a string array representing the shortnames of sites (workspaces) the user should have access to, such aswww.example.com
.
Assigning a group or user to the application
The following instructions apply to assigning groups, though users will follow a nearly identical process.
- In the Signal Sciences Okta application, click Assignments.
- From the Assign menu, select Assign to Groups.
- Select a group of users to provision. A window appears requesting additional attributes.
- Select the Role for the assigned group. This can be one of owner, admin, user, or observer.
- Click Add Another to add a site. This is the “short name” of the site that appears in your Site settings.
- Click Save and Go Back.
Managing users with the IdP
User management includes both updates to attributes and user deletion.
Updating users
Updates to the group and user attributes will be synchronized, including:
- The user’s real name
- The user’s assigned role
- The user’s assigned sites (workspaces)
Next-Gen WAF does not support updating the user’s email address, as it is the primary identifier for the user.
Deleting users
Next-Gen WAF users are removed via provisioning in a few ways:
- Remove the user from a group assigned to the Next-Gen WAF application
- Directly remove the user from the Next-Gen WAF application if they are directly assigned
- Deactivating the user in Okta
The user will be re-created if the user is reactivated or re-assigned to the Signal Sciences Okta application.
Troubleshooting
SCIM Provisioning was added to the Okta application in December 2020. If you have a Signal Sciences application in Okta that was created before December 2020, you may need to create a new Signal Sciences application in Okta in order to use SCIM provisioning.
If you have questions or difficulties with the Okta integration, reach out to our Support team for assistance.
Do not use this form to send sensitive information. If you need assistance, contact support. This form is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.