License Pools: Adding Users With SSO / SCIM

This article outlines how admins can add users to license pools via SSO (SAML) or SCIM methods. 

A user can only be in one license pool at a time, so moving a user to a pool will remove them from their existing pool. 

Glossary

License Pool: A license pool allows organizations to allocate a certain number of licenses to that pool. This is useful when different groupings within an organization have been allotted a specific number of licenses. Learn more.

Default License Pool: Every organization starts with a default license pool. This pool acts as a fallback and cannot be deleted or have its name changed. 

Custom License Pool: A custom license pool is any license pool the organization creates. 

IdP: Customer’s identity provider. 

Using SSO to adder users to license pools

Initial setup

Step 1: Admins create license pools in their organization’s Udemy Business account. Learn how.

Step 2: Admins create groups in their IdP with the licensePoolName attribute matching the license pool they have created in Udemy Business. (The attribute may be assigned on an individual basis, in the IdP, if that is the customer’s preference.) 

Usage

If the admin has not created any custom license pools in their Udemy Business account, the licensePoolName attribute will be ignored in the SAML request. 

If custom pools exist in the organization and the licensePoolName attribute is filled, our system will expect a valid name of a pool (an exact match, not case sensitive), or it will accept the string “default license pool” to signify the user should go to the default license pool. 

If there is not an exact match, the system will reject the request and show the user the appropriate error message. 

If the specified license pool is full, and the user is not already in the pool or is in the pool but deactivated, our system will reject the request and show the appropriate error message. 

Important: When managing a user’s license pool allocation via SSO, the user’s license pool must be changed in the IdP. Changing the user’s pool in Udemy Business will be reverted back to the IdP’s settings once the user logs in.

Important: Changing the name of the license pool in only Udemy Business, so that it does not match the license pool name used in the IdP, will result in the SAML request being rejected and the user will be unable to log in. 

Using SCIM to add users to license pools

SCIM will use the licensePoolName attribute. 

Initial setup

Step 1: Admins create license pools in their organization’s Udemy Business account. Learn how.

Step 2: Admins create groups in their IdP with the licensePoolName attribute matching the license pool they have created in Udemy Business. 

Usage

The admin will include the licensePoolName attribute in SCIM requests. 

If the admin has not created any custom license pools in their Udemy Business account, the licensePoolName attribute will be ignored 

If custom pools exist in the organization, we will expect a valid name of a pool (exact match, not case sensitive) or the string “default license pool” to signify the user should go to the default license pool. A blank field for the attribute will be assumed as the default license pool. 

If there is not an exact match, the system will reject the request and show the appropriate error message in the IdP. 

  • Behaviour if licensePoolName attribute does not match a license pool in Udemy Business: 
    • Provision 
      • Reject and show error message in IdP. 
    • User Update
  • Reject and show error message in IdP. 
  • Behaviour if the target license pool is full and has no remaining licenses left: 
    • Provision
      • User will be provisioned with the pending status. If the pool is still full when they try to login for the first time, they will receive an error. 
    • User Update
      • Reject and show error message in IdP. 

Related articles

Contact Us