Auto-provision Learners in LMS

Overview

Auto-provisioning provides a means for a new Contact to be provisioned automatically when a Learner users a Single Sign On (SSO) provider the first time they access the LMS portal. Upon authentication from an SSO provider, the learner will have access to the LMS and a Contact will be created in the Administrate TMS.

What Account will the Contact be created within?

A Contact will be provisioned in the TMS and will be allocated to an Account in the following priority order:

1. Default Account - You can choose a default account for all students to be created under when you set up Auto-provisioning. You do not have to set a default account.
2. Find a Company that matches the SSO claim, and use its first Account - this will happen if no Default Account has been configured. It looks for an exact name match and if found, it will create the contact under that account.
3. Individual Account - this will occur if no Default Account has been configured and we cannot match the Company to the SSO claim.

How to configure Auto-provisioning on a Brand?

There is currently no user interface to configure Auto-provisioning within the TMS so you will need to utilize GraphQL to configure the Brand you intend to use on the LMS portal. An example mutation is below.

Adding Auto-provisioning when you Create a Brands Identity Provider Configuration:

mutation create{
    brands{
        createIdentityProviderConfiguration(input:{
            brandId:"FIXME_BRAND_ID"
            identityProviderId:"FIXME_IDP_ID"
            autoProvisionLearners:true
            defaultAccountId:"FIXME_ACCOUNT_ID"
        }){
            brand{
            id
        }
        errors{
            label
            message
            value
        }
      }
   }
}

Adding Auto-provisioning when you Update a Brands Identity Provider Configuration:

mutation update{
    brands{
        updateIdentityProviderConfiguration(input:{
            brandId:"FIXME_BRAND_ID"
            identityProviderId:"FIXME_IDP_ID"
            autoProvisionLearners:true
            defaultAccountId:"FIXME_ACCOUNT_ID"
        }){
            brand{
            id
        }
        errors{
            label
            message
            value
        }
      }
   }
}

For further information on our API, please go to our Developer Documentation.

Additionally, you can contact the Support Team and they will be able to assist you in getting this configured within your preferred Brand.

FAQs

Q:What if the contact already exists in the TMS, but has no Credentials?

A: When the contact logs into the Portal for the first time using SSO, it will create the credentials and list them under the Credentials tab on the Contact record.