Configure Sugar user provisioning

As an administrator, once you've set up single sign-on (SSO), your next step is to configure automated user provisioning to authorize, create, modify, or delete your users' identity once in G Suite, and have the changes to that identity reflected in Sugar.

Set up user provisioning for the Sugar application
  1. Sign in to your Google Admin console.

    Sign in using your administrator account (does not end in @gmail.com).

  2. From the Admin console Home page, go to Apps and then SAML Apps.

    To see Apps on the Home page, you might have to click More controls at the bottom. 

  3. Click the Sugar application.
  4. Select User provisioning.
  5. Under User provisioning, click Set up user provisioning.
  6. In the Authorize window, enter your Sugar Administrator’s Username, and Password.
  7. Within the placeholder in the Token Url field, enter the domain name of your Sugar instance.
  8. If you have already created a separate OAuth Key (for GSuite User Provisioning) on the Sugar Admin portal, enter the Consumer Key value in the Client Id field and enter the Consumer Secret value in the Client Secret field.

    If not, you can follow the Sugar documentation on Creating OAuth Keys. Make sure you provide a strong consumer secret and choose the OAuth Version as 2.0.
  9. Click Next.

  10. In the Connection Url field, replace the text within the placeholder with your Sugar domain name. This is similar to how it’s done in the previous step for the Token Url field.

  11. Click Next.
  12. In the Map attributes dialog box:
    1. Next to the selected Cloud Directory attribute, click the Down arrow Down Arrow to map to the corresponding Sugar attribute. Attributes marked with (*) must be mapped.
    2. Click Next.
  13. (Optional) In the Set provisioning scope dialog box, add a group to restrict provisioning to members of groups you define:
    1. Click the underscore and begin typing your group name. 
      A list of available groups appears.
    2. Selecting one adds it and opens another underscore to use to add another. Add more groups, if necessary. 
    3. To remove any group you've added, click Edit Edit next to it.
  14. Once you’re done, click Finish.
  15. Review the information in the Provisioning summary dialog box, then click OK.
  16. Click Activate provisioning.
    Note: If you added groups using the Set provisioning scope dialog box, you must choose a scope. Otherwise, the Activate Provisioning button remains grayed out. You must set the app to On for everyone or On for some organizations and refresh the page before activating provisioning. If the app is set to Off, this choice is grayed out.
  17. In the confirmation dialog box, click Activate.
Display user provisioning

Once provisioning is enabled, Google begins collecting usage information. Next to User Provisioning, you see the usage information section. There aren't any numbers next to the event names until you enable provisioning.

The following event names provide the usage information for the last 30 days:

  • Users created
  • Users suspended
  • Users hard deleted
  • User failures

For more information, see Monitor user provisioning.

Edit provisioning scope

You may want to restrict the scope of provisioning to members of groups you define. 

  1. Sign in to your Google Admin console.

    Sign in using your administrator account (does not end in @gmail.com).

  2. From the Admin console Home page, go to Apps and then SAML Apps.

    To see Apps on the Home page, you might have to click More controls at the bottom. 

  3. Click the Sugar application.
  4. Select User provisioning.
  5. Under User provisioning, click Edit provisioning scope
  6. In the Set provisioning scope dialog box, add a group to restrict provisioning to members of groups you define:
    1. Click the underscore and begin typing your group name. 
      A list of available groups appears.
    2. Selecting one adds it and opens another underscore to use to add another. Add more groups, if necessary. 
    3. To remove any group you've added, click Edit Edit next to it.
  7. Once you’re done, click Finish.
  8. The next time you click Edit provisioning scope, the groups you added appear in the Set provisioning scope window. If you've turned on the Sugar application for a set of organizational units, the provisioning scope will be restricted to those users in the added groups who are also members of those organizations.
Deactivate user provisioning

To disable user provisioning for the Sugar application without losing all the configuration information:

  1. Sign in to your Google Admin console.

    Sign in using your administrator account (does not end in @gmail.com).

  2. From the Admin console Home page, go to Apps and then SAML Apps.

    To see Apps on the Home page, you might have to click More controls at the bottom. 

  3. Click the Sugar application.
  4. Select User provisioning.
  5. Under User provisioning, click Deactivate provisioning.
  6. In the Deactivate provisioning dialog box, click Deactivate
Define deprovisioning timeframes

To define how long deprovisioning actions should be delayed before taking effect:

  1. Sign in to your Google Admin console.

    Sign in using your administrator account (does not end in @gmail.com).

  2. From the Admin console Home page, go to Apps and then SAML Apps.

    To see Apps on the Home page, you might have to click More controls at the bottom. 

  3. Click the Sugar application.
  4. Select User provisioning.
  5. Under User provisioning, click Edit deprovisioning config.
  6. In the Deprovisioning configuration dialog box, select one or more of the following options to define how long deprovisioning actions should be delayed before taking effect:
    1. When an app is turned off for the user, suspend their account, hard delete their account, or both, after the number of days you choose

      A suspended account is temporarily unavailable until it's restored.

      A hard-deleted account can not be restored from either GSuite or Sugar. Please contact Sugar support to restore the user and their data.
       
    2. When a user is suspended on Google, suspend their account, hard delete their account, or both, after the number of days you choose.
    3. When a user is deleted from Google, suspend their account, hard delete their account, or both, after the number of days you choose.

      ​The amount of time before deprovisioning takes effect can be set to within 24 hours, after 1 day, after 7 days, or after 30 days.

      The default for each is to suspend the account within 24 hours. Always set the amount of time before deleting a user's account to more than the amount of time before suspending a user's account.
  7. Click Save.
Remove user provisioning

To disable user provisioning for the Sugar application and remove all configuration information:

  1. Sign in to your Google Admin console.

    Sign in using your administrator account (does not end in @gmail.com).

  2. From the Admin console Home page, go to Apps and then SAML Apps.

    To see Apps on the Home page, you might have to click More controls at the bottom. 

  3. Click the Sugar application.
  4. Select User provisioning.
  5. Under User provisioning, click Delete provisioning.
  6. In the Delete provisioning config dialog box, click Delete to deactivate user provisioning and remove all configuration information. 

    Existing users on Sugar are not deprovisioned.
Was this helpful?
How can we improve it?