SSO API: Configure Import of SSO Groups and Users

Beginning in FileCloud 23.251, admins can import FileCloud groups and users from Okta, Google, and Azure SSO providers. In the future, importing groups and users from additional providers may be available.

Systems that authenticate users with Okta, Google, or Azure SSO can also import the users and their groups from the SSO provider. This requires integration of FileCloud and the SSO provider, separate from the configuration of the SSO provider(s) on the SSO settings page or through the idpconfig file.

To set up the integration of the SSO provider and FileCloud for group and user import:

  • Step 1: Set up FileCloud to integrate with the SSO provider for group/user import in the SSO provider's application.
  • Step 2: Set up the SSO provider to integrate with FileCloud for group/user import in the FileCloud admin portal.

Step 1: Set up FileCloud to integrate with the SSO provider in the SSO provider's application:

Currently, the SSO providers available for integration with FileCloud for group/user import are Okta, Google, and Azure. 

Step 2: Set up the SSO provider for importing groups and users into FileCloud:

  1. Open the SSO API page.
    1. In the FileCloud admin portal's left navigation bar, scroll down and click Settings. Then, on the Settings navigation page, click Third Party Integrations .
    2. In the inner navigation bar on the left of the Third Party Integrations page, expand the Third Party Integrations menu, and click SSO API, as shown below.

      The SSO API settings page opens.
  2. Click Add Integration.
    The New SSO Integration dialog box opens.
  3. Enter a name for the integration and click the button for the corresponding SSO provider:

    The dialog box expands.
  4. Enter the integration values for the specific SSO provider:

    OKTA
    1. When you click the OKTA button under Select Provider, the following settings appear. Enter the value for each as indicated in the table below.

      Integration NameYou may enter any name.
      Client IDEnter the Client ID created for you when you set up the integration with FileCloud in Okta. You may copy it from the Okta Admin Console's listing for the application and paste it into the field. The following image shows where it appears in the Okta Admin Console.
      Private key fileChoose the .pem file that you saved your private key in. You may have created the file and saved it when you were setting up the integration with FileCloud in Okta
      DomainEnter the domain that Okta created for your user in Okta when you set up the integration with FileCloud in Okta. You may copy it from the Okta Admin Console's User drop-down box and paste it into the field. The following image shows where it appears in the Okta Admin Console.
      IdP endpoint URL or entity ID (Optional)Enter if you are using multiple IdP's. Enter the value in the field IdP endpoint URL or entity ID from the FileCloud SSO settings.

      Location of values for FileCloud fields in Okta Admin Console

       

    2. Once you have filled in the fields, click Test to make sure your integration works.
       
    3. If the test is successful, click Create.
      The integration is added to the list of SSO integrations:

    Azure
    1. When you click the Azure button under Select Provider, the following settings appear. Enter the value for each as indicated in the table below.

      Integration NameYou may enter any name.
      Tenant IDEnter the Directory (tenant) ID that you saved from the Overview page when you set up your integration with FileCloud in Azure, or copy it directly from that page in the Azure portal and paste it into the Tenant ID field. The first of the images below shows where it appears in the Azure portal.
      Client SecretEnter the Value that you saved from the Certificates & secrets page when you set up your integration with FileCloud in Azure, or copy it directly from that page in the Azure portal and paste it into the Client Secret field. The second of the images below shows where it appears in the Azure portal.
      Client IDEnter the Application (client) ID that you saved from the Overview page when you set up your integration with FileCloud in Azure, or copy it directly from that page in the Azure portal and paste it into the Client ID field. The first of the images below shows where it appears in the Azure portal.
      Select an attribute to be used as the email to import usersSelect the attribute that is used to authenticate the user in SSO. Options are Mail or userPrincipalName.
      IdP endpoint URL or entity ID (Optional)Enter if you are using multiple IdP's. Enter the value in the field IdP endpoint URL or entity ID from the FileCloud SSO settings.


      Location of values for FileCloud Client ID and Tenant ID fields in Azure portal.


      Location of value for FileCloud Client Secret field in Azure portal.

    2. Once you have filled in the fields, click Test to make sure your integration works.
    3. If the test is successful, click Create.
      The integration is added to the list of SSO integrations:




    Google 
    1. When you click the Google button under Select Provider, the following settings appear. Enter the value for each as indicated in the table below.


      Integration NameYou may enter any name.
      Customer IDFind the value that you saved for EntityID in the Google admin portal and copy the value after idpid= at the end into Customer ID. For example, if the value you saved was:
      https://accounts.google.com/o/saml2?idpid=ABC123DEF, enter ABC123DEF into Customer ID.
      The image below shows where it appears in the Google admin portal.
      Super admin e-mail addressThe e-mail address of the superadmin who added the integration of FileCloud and Google SSO in the Google admin portal and the Google Cloud Console.
      Private key fileThe json file that was created in the Google Cloud Console.
      IdP endpoint URL or entity IDIf you are using multiple IdP's, enter the IdP endpoint URL or entity ID from the FileCloud SSO settings.



      Location of the Customer ID value in the Google Admin Portal.

    2. Once you have filled in the fields, click Test to make sure your integration works.
    3. If the test is successful, click Create.
      The integration is added to the list of SSO integrations:




  5. Now import groups and users through your SSO integration on the Manage Groups page.