EntitlementsApi

All URIs are relative to https://sailpoint.api.identitynow.com

Method	HTTP request	Description
create-access-model-metadata-for-entitlement-v1	POST `/entitlements/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}`	Add metadata to an entitlement.
delete-access-model-metadata-from-entitlement-v1	DELETE `/entitlements/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}`	Remove metadata from an entitlement.
get-entitlement-request-config-v1	GET `/entitlements/v1/{id}/entitlement-request-config`	Get entitlement request config
get-entitlement-v1	GET `/entitlements/v1/{id}`	Get an entitlement
import-entitlements-by-source-v1	POST `/entitlements/v1/aggregate/sources/{id}`	Aggregate entitlements
list-entitlement-children-v1	GET `/entitlements/v1/{id}/children`	List of entitlements children
list-entitlement-parents-v1	GET `/entitlements/v1/{id}/parents`	List of entitlements parents
list-entitlements-by-account-v1	GET `/entitlements/v1/account/{accountId}/entitlements`	Get entitlements for an account
list-entitlements-v1	GET `/entitlements/v1`	Gets a list of entitlements.
patch-entitlement-v1	PATCH `/entitlements/v1/{id}`	Patch an entitlement
put-entitlement-request-config-v1	PUT `/entitlements/v1/{id}/entitlement-request-config`	Replace entitlement request config
reset-source-entitlements-v1	POST `/entitlements/v1/reset/sources/{id}`	Reset source entitlements
update-entitlements-in-bulk-v1	POST `/entitlements/v1/bulk-update`	Bulk update an entitlement list

create-access-model-metadata-for-entitlement-v1

Add metadata to an entitlement. Add single Access Model Metadata to an entitlement.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	The entitlement id.	[default to undefined]
attributeKey	`string`	Technical name of the Attribute.	[default to undefined]
attributeValue	`string`	Technical name of the Attribute Value.	[default to undefined]

Return type

Entitlement

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { EntitlementsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new EntitlementsApi(configuration);
const id: string = 2c91808c74ff913f0175097daa9d59cd; // The entitlement id.
const attributeKey: string = iscPrivacy; // Technical name of the Attribute.
const attributeValue: string = public; // Technical name of the Attribute Value.
const result = await apiInstance.createAccessModelMetadataForEntitlementV1({ id: id, attributeKey: attributeKey, attributeValue: attributeValue });
console.log(result);

[Back to top]

delete-access-model-metadata-from-entitlement-v1

Remove metadata from an entitlement. Remove single Access Model Metadata from an entitlement.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	The entitlement id.	[default to undefined]
attributeKey	`string`	Technical name of the Attribute.	[default to undefined]
attributeValue	`string`	Technical name of the Attribute Value.	[default to undefined]

Return type

(empty response body)

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { EntitlementsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new EntitlementsApi(configuration);
const id: string = 2c91808c74ff913f0175097daa9d59cd; // The entitlement id.
const attributeKey: string = iscPrivacy; // Technical name of the Attribute.
const attributeValue: string = public; // Technical name of the Attribute Value.
const result = await apiInstance.deleteAccessModelMetadataFromEntitlementV1({ id: id, attributeKey: attributeKey, attributeValue: attributeValue });
console.log(result);

[Back to top]

get-entitlement-request-config-v1

Get entitlement request config This API returns the entitlement request config for a specified entitlement.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	Entitlement Id	[default to undefined]

Return type

Entitlementrequestconfig

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { EntitlementsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new EntitlementsApi(configuration);
const id: string = 2c91808874ff91550175097daaec161c; // Entitlement Id
const result = await apiInstance.getEntitlementRequestConfigV1({ id: id });
console.log(result);

[Back to top]

get-entitlement-v1

Get an entitlement This API returns an entitlement by its ID.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	The entitlement ID	[default to undefined]

Return type

Entitlementv2

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { EntitlementsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new EntitlementsApi(configuration);
const id: string = 2c91808874ff91550175097daaec161c; // The entitlement ID
const result = await apiInstance.getEntitlementV1({ id: id });
console.log(result);

[Back to top]

import-entitlements-by-source-v1

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Aggregate entitlements Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent here.

If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error.

If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to multipart/form-data.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	Source Id	[default to undefined]
csvFile	`File`	The CSV file containing the source entitlements to aggregate.	[optional] [default to undefined]

Return type

Loadentitlementtask

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

Example

import { EntitlementsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new EntitlementsApi(configuration);
const id: string = ef38f94347e94562b5bb8424a56397d8; // Source Id
const csvFile: File = BINARY_DATA_HERE; // The CSV file containing the source entitlements to aggregate. (optional)
const result = await apiInstance.importEntitlementsBySourceV1({ id: id });
console.log(result);

[Back to top]

list-entitlement-children-v1

List of entitlements children This API returns a list of all child entitlements of a given entitlement.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	Entitlement Id	[default to undefined]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
searchAfter	`string`	Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is "Account Payable", then using that name and ID will start a new search after this entitlement.	[optional] [default to undefined]
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: id, name, created, modified, type, attribute, value, source.id, requestable	[optional] [default to undefined]
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq, in name: eq, in, sw type: eq, in attribute: eq, in value: eq, in, sw source.id: eq, in requestable: eq created: gt, lt, ge, le modified: gt, lt, ge, le owner.id: eq, in tags: eq privilegeLevel.direct: eq	[optional] [default to undefined]

Return type

Array<Entitlementv2>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { EntitlementsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new EntitlementsApi(configuration);
const id: string = 2c91808874ff91550175097daaec161c; // Entitlement Id
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const searchAfter: string = Account Payable,2c91808375d8e80a0175e1f88a575221; // Used to begin the search window at the values specified.  This parameter consists of the last values of the sorted fields in the current record set.  searchAfter length must match the number of sorters.  This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value.  It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\&#39;t get duplicate results while paging.  For example, if you are sorting by name you will also want to include ID, for example searchAfter&#x3D;Account Payable,2c91808375d8e80a0175e1f88a575221&amp;sorters&#x3D;name,id.  If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \&quot;Account Payable\&quot;, then using that name and ID will start a new search after this entitlement. (optional)
const sorters: string = name,id; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional)
const filters: string = attribute eq "memberOf"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **id**: *eq, in*  **name**: *eq, in, sw*  **type**: *eq, in*  **attribute**: *eq, in*  **value**: *eq, in, sw*  **source.id**: *eq, in*  **requestable**: *eq*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*  **owner.id**: *eq, in*  **tags**: *eq*  **privilegeLevel.direct**: *eq* (optional)
const result = await apiInstance.listEntitlementChildrenV1({ id: id });
console.log(result);

[Back to top]

list-entitlement-parents-v1

List of entitlements parents This API returns a list of all parent entitlements of a given entitlement.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	Entitlement Id	[default to undefined]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
searchAfter	`string`	Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is "Account Payable", then using that name and ID will start a new search after this entitlement.	[optional] [default to undefined]
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: id, name, created, modified, type, attribute, value, source.id, requestable	[optional] [default to undefined]
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq, in name: eq, in, sw type: eq, in attribute: eq, in value: eq, in, sw source.id: eq, in requestable: eq created: gt, lt, ge, le modified: gt, lt, ge, le owner.id: eq, in tags: eq privilegeLevel.direct: eq	[optional] [default to undefined]

Return type

Array<Entitlementv2>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { EntitlementsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new EntitlementsApi(configuration);
const id: string = 2c91808c74ff913f0175097daa9d59cd; // Entitlement Id
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const searchAfter: string = Account Payable,2c91808375d8e80a0175e1f88a575221; // Used to begin the search window at the values specified.  This parameter consists of the last values of the sorted fields in the current record set.  searchAfter length must match the number of sorters.  This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value.  It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\&#39;t get duplicate results while paging.  For example, if you are sorting by name you will also want to include ID, for example searchAfter&#x3D;Account Payable,2c91808375d8e80a0175e1f88a575221&amp;sorters&#x3D;name,id.  If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \&quot;Account Payable\&quot;, then using that name and ID will start a new search after this entitlement. (optional)
const sorters: string = name,id; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional)
const filters: string = attribute eq "memberOf"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **id**: *eq, in*  **name**: *eq, in, sw*  **type**: *eq, in*  **attribute**: *eq, in*  **value**: *eq, in, sw*  **source.id**: *eq, in*  **requestable**: *eq*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*  **owner.id**: *eq, in*  **tags**: *eq*  **privilegeLevel.direct**: *eq* (optional)
const result = await apiInstance.listEntitlementParentsV1({ id: id });
console.log(result);

[Back to top]

list-entitlements-by-account-v1

Get entitlements for an account This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404.

API Spec

Parameters

Name	Type	Description	Notes
accountId	`string`	The account ID to get entitlements for	[default to undefined]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
searchAfter	`string`	Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is "Account Payable", then using that name and ID will start a new search after this entitlement.	[optional] [default to undefined]
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: id, name, created, modified, type, attribute, value, source.id, requestable	[optional] [default to undefined]

Return type

Array<Entitlementv2>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { EntitlementsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new EntitlementsApi(configuration);
const accountId: string = ef38f94347e94562b5bb8424a56397d8; // The account ID to get entitlements for
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const searchAfter: string = Account Payable,2c91808375d8e80a0175e1f88a575221; // Used to begin the search window at the values specified.  This parameter consists of the last values of the sorted fields in the current record set.  searchAfter length must match the number of sorters.  This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value.  It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\&#39;t get duplicate results while paging.  For example, if you are sorting by name you will also want to include ID, for example searchAfter&#x3D;Account Payable,2c91808375d8e80a0175e1f88a575221&amp;sorters&#x3D;name,id.  If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \&quot;Account Payable\&quot;, then using that name and ID will start a new search after this entitlement. (optional)
const sorters: string = name,id; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional)
const result = await apiInstance.listEntitlementsByAccountV1({ accountId: accountId });
console.log(result);

[Back to top]

list-entitlements-v1

Gets a list of entitlements. This API returns a list of entitlements. Any authenticated token can call this API.

API Spec

Parameters

Name	Type	Description	Notes
segmentedForIdentity	`string`	If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID.	[optional] [default to undefined]
forSegmentIds	`string`	If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.	[optional] [default to undefined]
includeUnsegmented	`boolean`	Whether or not the response list should contain unsegmented Entitlements. If for-segment-ids and segmented-for-identity are both absent or empty, specifying include-unsegmented=false results in an error.	[optional] [default to true]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
searchAfter	`string`	Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is "Account Payable", then using that name and ID will start a new search after this entitlement.	[optional] [default to undefined]
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: id, name, created, modified, type, attribute, value, source.id, requestable	[optional] [default to undefined]
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq, in name: eq, in, sw type: eq, in attribute: eq, in value: eq, in, sw source.id: eq, in requestable: eq created: gt, lt, ge, le modified: gt, lt, ge, le owner.id: eq, in tags: eq privilegeLevel.direct: eq	[optional] [default to undefined]

Return type

Array<Entitlementv2>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { EntitlementsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new EntitlementsApi(configuration);
const segmentedForIdentity: string = e554098913544630b5985e9042f5e44b; // If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. (optional)
const forSegmentIds: string = 041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649; // If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. (optional)
const includeUnsegmented: boolean = true; // Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented&#x3D;false** results in an error. (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const searchAfter: string = Account Payable,2c91808375d8e80a0175e1f88a575221; // Used to begin the search window at the values specified.  This parameter consists of the last values of the sorted fields in the current record set.  searchAfter length must match the number of sorters.  This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value.  It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\&#39;t get duplicate results while paging.  For example, if you are sorting by name you will also want to include ID, for example searchAfter&#x3D;Account Payable,2c91808375d8e80a0175e1f88a575221&amp;sorters&#x3D;name,id.  If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \&quot;Account Payable\&quot;, then using that name and ID will start a new search after this entitlement. (optional)
const sorters: string = name,id; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional)
const filters: string = attribute eq "memberOf"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **id**: *eq, in*  **name**: *eq, in, sw*  **type**: *eq, in*  **attribute**: *eq, in*  **value**: *eq, in, sw*  **source.id**: *eq, in*  **requestable**: *eq*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*  **owner.id**: *eq, in*  **tags**: *eq*  **privilegeLevel.direct**: *eq* (optional)
const result = await apiInstance.listEntitlementsV1({  });
console.log(result);

[Back to top]

patch-entitlement-v1

Patch an entitlement This API updates an existing entitlement using JSON Patch syntax.

The following fields are patchable: requestable, segments, privilegeOverride/level, owner, name, description, and manuallyUpdatedFields

When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	ID of the entitlement to patch	[default to undefined]
jsonpatchoperation	`Array<Jsonpatchoperation>`		[optional]

Return type

Entitlementv2

HTTP request headers

Content-Type: application/json-patch+json
Accept: application/json

Example

import { EntitlementsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new EntitlementsApi(configuration);
const id: string = 2c91808a7813090a017814121e121518; // ID of the entitlement to patch
const jsonpatchoperation: Array&lt;Jsonpatchoperation&gt; = [{"op":"add","path":"/segments/-","value":"f7b1b8a3-5fed-4fd4-ad29-82014e137e19"}]; //  (optional)
const result = await apiInstance.patchEntitlementV1({ id: id });
console.log(result);

[Back to top]

put-entitlement-request-config-v1

Replace entitlement request config This API replaces the entitlement request config for a specified entitlement.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	Entitlement ID	[default to undefined]
entitlementrequestconfig	`Entitlementrequestconfig`

Return type

Entitlementrequestconfig

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

import { EntitlementsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new EntitlementsApi(configuration);
const id: string = 2c91808a7813090a017814121e121518; // Entitlement ID
const entitlementrequestconfig: Entitlementrequestconfig = ; // 
const result = await apiInstance.putEntitlementRequestConfigV1({ id: id, entitlementrequestconfig: entitlementrequestconfig });
console.log(result);

[Back to top]

reset-source-entitlements-v1

Reset source entitlements Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use Account Aggregation with disableOptimization = true.

API Spec

Parameters

Name	Type	Description	Notes
id	`string`	ID of source for the entitlement reset	[default to undefined]

Return type

Entitlementsourceresetbasereferencedto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { EntitlementsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new EntitlementsApi(configuration);
const id: string = 2c91808a7813090a017814121919ecca; // ID of source for the entitlement reset
const result = await apiInstance.resetSourceEntitlementsV1({ id: id });
console.log(result);

[Back to top]

update-entitlements-in-bulk-v1

Bulk update an entitlement list This API applies an update to every entitlement of the list.

The number of entitlements to update is limited to 50 items maximum.

The JsonPatch update follows the JSON Patch standard. examples of allowed operations : **{ "op": "replace", "path": "/requestable","value": boolean }** **{ "op": "replace", "path": "/privilegeOverride/level","value": string }**

A token with ORG_ADMIN or API authority is required to call this API.

API Spec

Parameters

Name	Type	Description	Notes
entitlementbulkupdaterequest	`Entitlementbulkupdaterequest`

Return type

(empty response body)

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

import { EntitlementsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new EntitlementsApi(configuration);
const entitlementbulkupdaterequest: Entitlementbulkupdaterequest = ; // 
const result = await apiInstance.updateEntitlementsInBulkV1({ entitlementbulkupdaterequest: entitlementbulkupdaterequest });
console.log(result);

[Back to top]

create-access-model-metadata-for-entitlement-v1​

Parameters​

Return type​

HTTP request headers​

Example​

delete-access-model-metadata-from-entitlement-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-entitlement-request-config-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-entitlement-v1​

Parameters​

Return type​

HTTP request headers​

Example​

import-entitlements-by-source-v1​

Parameters​

Return type​

HTTP request headers​

Example​

list-entitlement-children-v1​

Parameters​

Return type​

HTTP request headers​

Example​

list-entitlement-parents-v1​

Parameters​

Return type​

HTTP request headers​

Example​

list-entitlements-by-account-v1​

Parameters​

Return type​

HTTP request headers​

Example​

list-entitlements-v1​

Parameters​

Return type​

HTTP request headers​

Example​

patch-entitlement-v1​

Parameters​

Return type​

HTTP request headers​

Example​

put-entitlement-request-config-v1​

Parameters​

Return type​

HTTP request headers​

Example​

reset-source-entitlements-v1​

Parameters​

Return type​

HTTP request headers​

Example​

update-entitlements-in-bulk-v1​

Parameters​

Return type​

HTTP request headers​

Example​

create-access-model-metadata-for-entitlement-v1

Parameters

Return type

HTTP request headers

Example

delete-access-model-metadata-from-entitlement-v1

Parameters

Return type

HTTP request headers

Example

get-entitlement-request-config-v1

Parameters

Return type

HTTP request headers

Example

get-entitlement-v1

Parameters

Return type

HTTP request headers

Example

import-entitlements-by-source-v1

Parameters

Return type

HTTP request headers

Example

list-entitlement-children-v1

Parameters

Return type

HTTP request headers

Example

list-entitlement-parents-v1

Parameters

Return type

HTTP request headers

Example

list-entitlements-by-account-v1

Parameters

Return type

HTTP request headers

Example

list-entitlements-v1

Parameters

Return type

HTTP request headers

Example

patch-entitlement-v1

Parameters

Return type

HTTP request headers

Example

put-entitlement-request-config-v1

Parameters

Return type

HTTP request headers

Example

reset-source-entitlements-v1

Parameters

Return type

HTTP request headers

Example

update-entitlements-in-bulk-v1

Parameters

Return type

HTTP request headers

Example