Skip to main content

Auto-provision Learners in LMS

Updated

Overview

Auto-provisioning lets a new contact be created automatically the first time a learner signs in to the LMS using a single sign-on (SSO) provider.

After successful authentication, the learner can access the LMS and a corresponding contact record is created in Administrate TMS.

Which account is the contact created under?

The contact is created in the TMS and assigned to an account using the following priority order:

  1. Default account — You can optionally set a default account for all auto-provisioned learners.
  2. Company match — If no default account is configured, Administrate looks for a company name that exactly matches the SSO claim and uses that company’s first account.
  3. Individual account — If there is no default account and no company match, the contact is created under an individual account.

Configure auto-provisioning for a brand

Auto-provisioning is configured per brand. There is currently no UI to configure this in the TMS. Use GraphQL to update the identity provider configuration for the brand used by your LMS portal.

Create an identity provider configuration with auto-provisioning enabled

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 }
    }
  }
}

Update an existing identity provider configuration to enable auto-provisioning

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 more on our APIs, see the Developer Documentation.

If you prefer, you can contact Support and they can help configure auto-provisioning for your chosen brand.

FAQs

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

A: When the contact signs in to the portal for the first time using SSO, Administrate creates the credentials and lists them on the contact record under the Credentials tab.

Related articles