Skip to content

Aggregate User Groups and User Group as an Entitlement

Aggregating the User Group and User Groups entitlements provides native support for user group attributes during account aggregation and provisioning. For newly created sources, these entitlements are managed by default using the User Group ID.

How to Enable the Feature for an Existing Source

If you are using an existing source, you must manually update the source configuration using the REST API to enable this feature and apply the required schemas.

  1. Add the User Group Schema

    Ensure the source includes the following usergroup schema configuration:

    {
      "aggregationType": "group",
      "displayAttribute": "User Group",
      "identityAttribute": "User Group",
      "nativeObjectType": "UserGroup",
      "objectType": "usergroup",
      "attributeDefinitions": [
        {
          "name": "User Group Auth",
          "type": "string",
          "description": "User Group Id"
        },
        {
          "name": "Language",
          "type": "string",
          "description": "Language of the group"
        },
        {
          "name": "Description",
          "type": "string",
          "description": "Description of the user group auth"
        }
      ]
    }
    
  2. Add the User Groups Schema

    {
      "aggregationType": "group",
      "displayAttribute": "User Groups",
      "identityAttribute": "User Group",
      "nativeObjectType": "UserGroups",
      "objectType": "usergroups",
      "attributeDefinitions": [
        {
          "name": "User Group",
          "type": "string",
          "description": "User Group Id"
        },
        {
          "name": "Language",
          "type": "string",
          "description": "Language of the group"
        },
        {
          "name": "Description",
          "type": "string",
          "description": "Description of the user group assigned"
        }
      ]
    }
    

Updating Account Schema Attribute Types

After you add the UserGroup and UserGroups entitlement schemas to an existing source, update the corresponding account schema attributes so their types match the entitlement schemas.

Note

New sources created with User Group entitlements enabled use the correct attribute types by default. Verify the account schema before making changes.

To update account schema attribute types:

<AttributeDefinition entitlement="true" managed="true" multi="true" name="User Group" schemaObjectType="usergroup" type="string">
        <Description>User Group Auth assignment</Description>
</AttributeDefinition>
<AttributeDefinition entitlement="true" managed="true" multi="true" name="User Groups" schemaObjectType="usergroups" type="string">
        <Description>User Group Assignments of the user</Description>
</AttributeDefinition>
  1. Log in to SailPoint.
  2. Select the Admin tab and provide the necessary credentials if prompted.
  3. Go to Connections > Sources.
  4. Select the SAP Direct source.
  5. Go to Account Schema.
  6. Select the User Group attribute.
  7. Set Type to usergroup.

    Set Type to usergroup

  8. Save the attribute.

  9. Select the User Groups attribute.
  10. Set Type to usergroups.

    Set Type to usergroups

  11. Save the attribute.

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.