A collection is a group of catalog resources, in the form of roles, applications and entitlements, which can be exported and used as a reference. IDHub also allows for a BULK import of collections, which can be completed using a JSON file import.

Our collections feature is primarily used with IDHub's self-hosted server version, allowing organizations to replicate data across multiple environments.

In order to reach the Manage Collections page, you will need to click on the “Manage Collections” tab located in the left panel.


Collections Grid

The manage collections page shows all collections that have been previously created in IDHub.

The following details will be shown for each collection:

  • Collection Name

  • Collection Tags

  • Collection Description

Available actions are as follows:

  • Edit Button

    • After clicking on the “Pencil” icon, IDHub opens the collection in an editable version, allowing for quick edits to all fields within the collection.

  • Ellipsis Button

    • Remove the Collection

      • This allows you to remove or delete the collection from IDHub.

    • Export JSON

      • This allows you to export a JSON file for the collection. This is feature will be available in an upcoming release of IDHub.


Create New Collection

To create a new collection, simply click on the “Create New Collection” button located on the top, right corner of the page, allowing for:

  • Create New Collection

  • Import collection

The following details are shown when “Create New Collection” is selected:

Basic Details Page

In order to create a new collection, you will need to enter the following information:

  • Collection Name

  • Description

  • Search Keywords

  • Business Owner

    • The Business Owner is the IDHub user who will be responsible for all non-IT aspects of this collection. As you type the name of the user who will be selected as the Business Owner, IDHub will populate active, appropriate users, who can then be chosen from the drop-down selection.

  • IT Owner

    • The IT Owner is the IDHub user who will be responsible for all IT aspects of this collection. As you type the name of the user who will be selected as the IT Owner, IDHub will populate active, appropriate users, who can then be chosen from the drop-down selection.

  • IDM drop-down

    • Select the applicable IDM version. For now, IDHub supports IDE SHIM.

After completing the above details, click the “Next” button.

Preview Page

The Preview Page is used to select the catalog resources, which will be added to the Collection.

To add a resource to the collection, simply click on the “+” icon. This will add the resource to the “Selected” column, located on the right.

Use the “Search” icon to quickly search for a specific resource.

As you can see in the below image, all selected resources will be shown within the “Selected” column, located on the right.

If an added resource needs to be removed, simply click on the “-” icon next to each resource which needs removal.

To remove ALL resources from the right column, click on the “Remove All” button.

Once all resources have been added, the following options are available:

  • Save as draft

    • This allows you to save the details which were entered, and access the draft at a later time.

  • Previous

    • This takes you to the previous page, where additional edits can be made.

  • Submit

    • This allows you to submit the new collection for appropriate approval from an Access Manager.

Click the “Submit” button and enter the reason for creating this new collection. Once submitted, an Access Manager would need to claim and approve the task for the new collection. Once the task has been claimed and approved, the new collection will be available for use on the “Manage Collections” page.


Bulk Import Collection

IDHub allows for Bulk importing. To bulk import, click on “Create New collection”, and select “Import Collections” from the drop-down menu.

In order to appropriately bulk import collections, you will need to follow the below steps:

  • Select IDM Version

    • Select the applicable IDM version. For now, IDHub supports IDE SHIM.

  • Upload File

    • Upload a JSON file, which contains the details for each collection, in the form of applications, roles and entitlements.

    • Make sure the JSON file size does not exceed 25 MB.

After uploading the file, IDHub will show any error, update, or warning messages. You can review the messages and make any needed corrections to the JSON file. Once the file is corrected, upload the file again to ensure all error and/or warnings have been resolved.

Once there are no errors and/or warnings, proceed with the import.

Once the appropriate approvals have been completed, IDHub will process the JSON file, and on-board the new collections.