Web Services - Entitlement Types

I have a use case where source is of type Web Services and there are 4 types of Entitlements (Say TypeA, TypeB, TypeC, TypeD).

Each type has hundreds of Entitlements, and each Entitlement has an ID and value.

Entitlement types (A,B,C,D) are added to Account Schema as attributes (Entitlement and Multivalued)

I am trying to understand how can I aggregate these into IDN using Entitlement Types under Import Data tab of a Web Services type Source.

If I create 4 types using this, how would I set up 4 off Entitlement Aggregation (Group Aggregation) Http Operations in such a way that each of these operations will be linked to one of the types.

I am hoping to find some documentation with examples to use this particular feature and hoping someone will guide me in the right direction.

1 Like

Hi @iam_nithesh - This can be done by adding the new group schema schema. To support multi groups, add the following API to add a new schema:

  • Method – POST
  • URI – beta/sources/<source-id>/schemas

JSON Payload:

The following JSON example adds the schema for the Role that follows:

{
    "name": "Role",
    "nativeObjectType": "Role",
    "identityAttribute": "Id",
    "displayAttribute": "Name",
    "hierarchyAttribute": null,
    "includePermissions": false,
    "features": [],
    "configuration": {},
    "attributes": [
    {
    "name": "Id",
    "type": "STRING",
    "schema": null,
    "description": "Role Id.",
    "isMulti": false,
    "isEntitlement": false,
    "isGroup": false
    },
    {
    "name": "Name",
    "type": "STRING",
    "schema": null,
    "description": "Role name.",
    "isMulti": false,
    "isEntitlement": false,
    "isGroup": false
    }
     ]
}

This will add new endpoints in Webservice configuration to handle multiple group object. You can refer to this documentation for more detail - Multiple Group Objects

1 Like

You need to define Entitlement Schema and you can do it using UI itself. You do not need api to do that.
Go into Entitlement Types and define schema for each type. Once you have defined schema for each one you will need to change type in account schema for those entitlement types.

Here’s sample entitlement schema

Do note the type here is “Group” and you will have total 4 types, A,B,C AND D. Once you define these go back into account schema and change type of them to respective types.

After you complete these steps you will see “Operation Type” for each Entitlement Type you have configured in source config. You can map id and value just like any other end point.

Important thing to keep in mind is , whichever attribute you mark as “AccountId” in entitlement schema, make sure you are aggregating that only in account aggregation, that’s how identitynow correlates data coming through 2 different aggreation(account and group aggregation)

In my case id of the role is accountid in group schema so I am aggregating roleid in account schema.

Hope this helps

2 Likes

Thanks @smukhija and @chirag_patel
Both your answers helped me resolve this. Wish I could mark both responses as Solution (I tried :blush:)

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.