Difference between API Create/Update Entitlement and Create Task - AD Group

[AJ23494]

Hi Experts , 

While going through the API Documentation , i got confused in two APIs as they look almost similar to me 

Could you please explain the difference and best case use scenario of the same  ? 

API 1 : Create Task - AD Group
https://documenter.getpostman.com/view/1797923/TVsvi7G2?version=latest#5e8082b2-6e68-43e3-90a4-c8c24...

API2 :  

Create/Update Entitlement

https://documenter.getpostman.com/view/1797923/TVsvi7G2?version=latest#87d79119-054f-4bb3-8f02-f6727...

Thanks in advance !!

Regards , 
Ankit Jindal 

[DixshantValecha]

I appreciate you reaching out to the Saviynt forums.

Based on the API documentation you provided, here are the differences and use cases of the two APIs:

1.Create Task - AD Group:

This is an API  that can be used to call an endpoint that creates a new task for creating an entitlement.

• The object includes several properties:

  • username: The username of the user for whom the entitlement will be created.

  • role: The role that will be granted to the user, specified as a distinguished name (DN) of a group in Active Directory.

  • endpointname: The name of the endpoint where the entitlement will be created.

  • tasktype: The type of task that will be created, which in this case is "CREATEENTITLEMENT".

  • assignmenttype: The type of assignment that the task will create, which in this case is "ENTITLEMENTS".

  • comments: Optional comments to include with the task.

#This can be used to call an API endpoint that creates a task for creating an entitlement for a specific user, with a specific role and on a specific endpoint. The task will be created with the specified assignment type and type of task. The API endpoint may then execute the task, which will create the entitlement for the specified user with the specified role.

2.Create/Update Entitlement:

This API is used to create or update an entitlement, which is a permission or right granted to a user or group to access a specific resource. The API allows you to define the name of the entitlement, the description, the type of entitlement (e.g., role, permission), and the specific resource(s) to which the entitlement grants access.

The request body sent in the command includes the following parameters:

• endpoint: The name of the endpoint for which entitlement values are being requested.

• entitlementType: The type of entitlement for which values are being requested, which in this case is "Security-Groups".

• entownerwithrank: A boolean value that indicates whether the entitlement owner information should be returned along with the entitlement values. If set to "true", the response will include the entitlement owner information along with each entitlement value.

#The expected output of this command is a JSON object that contains an array of entitlement values for the specified endpoint and entitlement type. The structure of the output may vary depending on the API endpoint implementation, but it may look something like this:.

{
"msg": "Successful",
"entitlementValues": [
"Accounts Receivable Specialist (Unconstrained)",
"Billing Specialist",
"Employee",
"Manager"
],
"entitlementOwners": {
"Accounts Receivable Specialist (Unconstrained)": {
"Rank 1": [
"jdoe",
"asmith"
]
},
"Billing Specialist": {
"Rank 1": [
"jdoe",
"asmith"
],
"Rank 2": [
"jdoe2",
"asmith2"
]
},
"errorCode": "0"
}

Please let us know if further information is needed on this.

Link:-

API 1 : Create Task - AD Group:
https://documenter.getpostman.com/view/1797923/TVsvi7G2?version=latest#5e8082b2-6e68-43e3-90a4-c8c24...

API2 :  

Create/Update Entitlement

https://documenter.getpostman.com/view/1797923/TVsvi7G2?version=latest#87d79119-054f-4bb3-8f02-f6727...