Skip to main content

EntitlementsService

Every method returns an Observable. All request paths are relative to the baseUrl you pass to provideSailPoint().

MethodHTTP requestDescription
create-access-model-metadata-for-entitlement-v1POST /entitlements/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}Add metadata to an entitlement.
delete-access-model-metadata-from-entitlement-v1DELETE /entitlements/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}Remove metadata from an entitlement.
get-entitlement-request-config-v1GET /entitlements/v1/{id}/entitlement-request-configGet entitlement request config
get-entitlement-v1GET /entitlements/v1/{id}Get an entitlement
import-entitlements-by-source-v1POST /entitlements/v1/aggregate/sources/{id}Aggregate entitlements
list-entitlement-children-v1GET /entitlements/v1/{id}/childrenList of entitlements children
list-entitlement-parents-v1GET /entitlements/v1/{id}/parentsList of entitlements parents
list-entitlements-by-account-v1GET /entitlements/v1/account/{accountId}/entitlementsGet entitlements for an account
list-entitlements-v1GET /entitlements/v1Gets a list of entitlements.
patch-entitlement-v1PATCH /entitlements/v1/{id}Patch an entitlement
put-entitlement-request-config-v1PUT /entitlements/v1/{id}/entitlement-request-configReplace entitlement request config
reset-source-entitlements-v1POST /entitlements/v1/reset/sources/{id}Reset source entitlements
update-entitlements-in-bulk-v1POST /entitlements/v1/bulk-updateBulk update an entitlement list
update-entitlements-metadata-by-filter-v1POST /entitlements/v1/access-model-metadata/bulk-update/filterBulk-update metadata by filter
update-entitlements-metadata-by-ids-v1POST /entitlements/v1/access-model-metadata/bulk-update/idsBulk-update metadata by ids
update-entitlements-metadata-by-query-v1POST /entitlements/v1/access-model-metadata/bulk-update/queryBulk-update metadata by query

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

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

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is CreateAccessModelMetadataForEntitlementV1RequestParams.

NameTypeDescriptionNotes
idstringThe entitlement id.[default to undefined]
attributeKeystringTechnical name of the Attribute.[default to undefined]
attributeValuestringTechnical name of the Attribute Value.[default to undefined]

Return type​

Observable<Entitlement>

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  createAccessModelMetadataForEntitlementV1(): void {
    const id: string = ; // The entitlement id.
    const attributeKey: string = ; // Technical name of the Attribute.
    const attributeValue: string = ; // Technical name of the Attribute Value.
    this.api.createAccessModelMetadataForEntitlementV1({ id: id, attributeKey: attributeKey, attributeValue: attributeValue }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[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​

The service takes one object that holds every parameter. Its type is DeleteAccessModelMetadataFromEntitlementV1RequestParams.

NameTypeDescriptionNotes
idstringThe entitlement id.[default to undefined]
attributeKeystringTechnical name of the Attribute.[default to undefined]
attributeValuestringTechnical name of the Attribute Value.[default to undefined]

Return type​

Observable<void> (empty response body)

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  deleteAccessModelMetadataFromEntitlementV1(): void {
    const id: string = ; // The entitlement id.
    const attributeKey: string = ; // Technical name of the Attribute.
    const attributeValue: string = ; // Technical name of the Attribute Value.
    this.api.deleteAccessModelMetadataFromEntitlementV1({ id: id, attributeKey: attributeKey, attributeValue: attributeValue }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-entitlement-request-config-v1​

Get entitlement request config This API returns the entitlement request config for a specified entitlement. The accessRequestConfig.formDefinitionId field associates an optional custom form with entitlement access requests.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is GetEntitlementRequestConfigV1RequestParams.

NameTypeDescriptionNotes
idstringEntitlement Id[default to undefined]

Return type​

Observable<EntitlementRequestConfig>

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  getEntitlementRequestConfigV1(): void {
    const id: string = ; // Entitlement Id
    this.api.getEntitlementRequestConfigV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-entitlement-v1​

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

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is GetEntitlementV1RequestParams.

NameTypeDescriptionNotes
idstringThe entitlement ID[default to undefined]

Return type​

Observable<EntitlementV2>

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  getEntitlementV1(): void {
    const id: string = ; // The entitlement ID
    this.api.getEntitlementV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[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​

The service takes one object that holds every parameter. Its type is ImportEntitlementsBySourceV1RequestParams.

NameTypeDescriptionNotes
idstringSource Id[default to undefined]
csvFileBlobThe CSV file containing the source entitlements to aggregate.[optional] [default to undefined]

Return type​

Observable<LoadEntitlementTask>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  importEntitlementsBySourceV1(): void {
    const id: string = ; // Source Id
    const csvFile: Blob = ; // The CSV file containing the source entitlements to aggregate. (optional)
    this.api.importEntitlementsBySourceV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[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​

The service takes one object that holds every parameter. Its type is ListEntitlementChildrenV1RequestParams.

NameTypeDescriptionNotes
idstringEntitlement Id[default to undefined]
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset 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]
countbooleanIf 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]
searchAfterstringUsed 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=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=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] [default to undefined]
sortersstringSort 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]
filtersstringFilter 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​

Observable<Array<EntitlementV2>>

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  listEntitlementChildrenV1(): void {
    const id: string = ; // Entitlement Id
    const limit: number = ; // 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 = ; // 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 = ; // 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 = ; // 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 = ; // 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 = ; // 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)
    this.api.listEntitlementChildrenV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[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​

The service takes one object that holds every parameter. Its type is ListEntitlementParentsV1RequestParams.

NameTypeDescriptionNotes
idstringEntitlement Id[default to undefined]
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset 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]
countbooleanIf 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]
searchAfterstringUsed 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=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=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] [default to undefined]
sortersstringSort 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]
filtersstringFilter 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​

Observable<Array<EntitlementV2>>

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  listEntitlementParentsV1(): void {
    const id: string = ; // Entitlement Id
    const limit: number = ; // 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 = ; // 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 = ; // 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 = ; // 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 = ; // 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 = ; // 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)
    this.api.listEntitlementParentsV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[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​

The service takes one object that holds every parameter. Its type is ListEntitlementsByAccountV1RequestParams.

NameTypeDescriptionNotes
accountIdstringThe account ID to get entitlements for[default to undefined]
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset 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]
countbooleanIf 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]
searchAfterstringUsed 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=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=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] [default to undefined]
sortersstringSort 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​

Observable<Array<EntitlementV2>>

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  listEntitlementsByAccountV1(): void {
    const accountId: string = ; // The account ID to get entitlements for
    const limit: number = ; // 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 = ; // 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 = ; // 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 = ; // 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 = ; // 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)
    this.api.listEntitlementsByAccountV1({ accountId: accountId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[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​

The service takes one object that holds every parameter. Its type is ListEntitlementsV1RequestParams.

NameTypeDescriptionNotes
segmentedForIdentitystringIf 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]
forSegmentIdsstringIf 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]
includeUnsegmentedbooleanWhether 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]
offsetnumberOffset 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]
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
countbooleanIf 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]
searchAfterstringUsed 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=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=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] [default to undefined]
sortersstringSort 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]
filtersstringFilter 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​

Observable<Array<EntitlementV2>>

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  listEntitlementsV1(): void {
    const 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)
    const 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)
    const 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&#x3D;false** results in an error. (optional)
    const offset: number = ; // 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 = ; // 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 = ; // 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 = ; // 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 = ; // 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 = ; // 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)
    this.api.listEntitlementsV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[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, manuallyUpdatedFields, and accessModelMetadata

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.

When you're patching accessModelMetadata, each attribute's key must match the key of an existing access model metadata attribute, and each value must be one of the values configured for that key. Use List access model metadata attributes to look up the available keys and values.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is PatchEntitlementV1RequestParams.

NameTypeDescriptionNotes
idstringID of the entitlement to patch[default to undefined]
jsonPatchOperationArray<JsonPatchOperation>[optional]

Return type​

Observable<EntitlementV2>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';
import { JsonPatchOperation } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  patchEntitlementV1(): void {
    const id: string = ; // ID of the entitlement to patch
    const jsonPatchOperation: Array<JsonPatchOperation> = ; //  (optional)
    this.api.patchEntitlementV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

put-entitlement-request-config-v1​

Replace entitlement request config This API replaces the entitlement request config for a specified entitlement. Set accessRequestConfig.formDefinitionId to associate an optional custom form with entitlement access requests.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is PutEntitlementRequestConfigV1RequestParams.

NameTypeDescriptionNotes
idstringEntitlement ID[default to undefined]
entitlementRequestConfigEntitlementRequestConfig

Return type​

Observable<EntitlementRequestConfig>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';
import { EntitlementRequestConfig } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  putEntitlementRequestConfigV1(): void {
    const id: string = ; // Entitlement ID
    const entitlementRequestConfig: EntitlementRequestConfig = ; // 
    this.api.putEntitlementRequestConfigV1({ id: id, entitlementRequestConfig: entitlementRequestConfig }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[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​

The service takes one object that holds every parameter. Its type is ResetSourceEntitlementsV1RequestParams.

NameTypeDescriptionNotes
idstringID of source for the entitlement reset[default to undefined]

Return type​

Observable<EntitlementSourceResetBaseReferenceDto>

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  resetSourceEntitlementsV1(): void {
    const id: string = ; // ID of source for the entitlement reset
    this.api.resetSourceEntitlementsV1({ id: id }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[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​

The service takes one object that holds every parameter. Its type is UpdateEntitlementsInBulkV1RequestParams.

NameTypeDescriptionNotes
entitlementBulkUpdateRequestEntitlementBulkUpdateRequest

Return type​

Observable<void> (empty response body)

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';
import { EntitlementBulkUpdateRequest } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  updateEntitlementsInBulkV1(): void {
    const entitlementBulkUpdateRequest: EntitlementBulkUpdateRequest = ; // 
    this.api.updateEntitlementsInBulkV1({ entitlementBulkUpdateRequest: entitlementBulkUpdateRequest }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

update-entitlements-metadata-by-filter-v1​

Bulk-update metadata by filter This API initiates a bulk update of Access Model Metadata for every entitlement matching the supplied filter expression.

The update is processed asynchronously. The response returns the ID of the task performing the update.

Adding or replacing custom metadata requires a suite license.

This API replaces the deprecated updateAccessModelMetadataByFilterV1 operation.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is UpdateEntitlementsMetadataByFilterV1RequestParams.

NameTypeDescriptionNotes
entitlementmetadatabulkupdatebyfilterrequestEntitlementmetadatabulkupdatebyfilterrequestAttribute metadata bulk update request body.

Return type​

Observable<Entitlementmetadatabulkupdateresponse>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';
import { Entitlementmetadatabulkupdatebyfilterrequest } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  updateEntitlementsMetadataByFilterV1(): void {
    const entitlementmetadatabulkupdatebyfilterrequest: Entitlementmetadatabulkupdatebyfilterrequest = ; // Attribute metadata bulk update request body.
    this.api.updateEntitlementsMetadataByFilterV1({ entitlementmetadatabulkupdatebyfilterrequest: entitlementmetadatabulkupdatebyfilterrequest }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

update-entitlements-metadata-by-ids-v1​

Bulk-update metadata by ids This API initiates a bulk update of Access Model Metadata for one or more entitlements by a list of entitlement IDs.

The update is processed asynchronously. The response returns the ID of the task performing the update.

The maximum entitlement count in a single request is 3000. Adding or replacing custom metadata requires a suite license.

This API replaces the deprecated updateAccessModelMetadataByIdsV1 operation.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is UpdateEntitlementsMetadataByIdsV1RequestParams.

NameTypeDescriptionNotes
entitlementmetadatabulkupdatebyidrequestEntitlementmetadatabulkupdatebyidrequestAttribute metadata bulk update request body.

Return type​

Observable<Entitlementmetadatabulkupdateresponse>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';
import { Entitlementmetadatabulkupdatebyidrequest } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  updateEntitlementsMetadataByIdsV1(): void {
    const entitlementmetadatabulkupdatebyidrequest: Entitlementmetadatabulkupdatebyidrequest = ; // Attribute metadata bulk update request body.
    this.api.updateEntitlementsMetadataByIdsV1({ entitlementmetadatabulkupdatebyidrequest: entitlementmetadatabulkupdatebyidrequest }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

update-entitlements-metadata-by-query-v1​

Bulk-update metadata by query This API initiates a bulk update of Access Model Metadata for every entitlement matching the supplied search query.

The update is processed asynchronously. The response returns the ID of the task performing the update.

Adding or replacing custom metadata requires a suite license.

This API replaces the deprecated updateAccessModelMetadataByQueryV1 operation.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is UpdateEntitlementsMetadataByQueryV1RequestParams.

NameTypeDescriptionNotes
entitlementmetadatabulkupdatebyqueryrequestEntitlementmetadatabulkupdatebyqueryrequestAttribute metadata bulk update request body.

Return type​

Observable<Entitlementmetadatabulkupdateresponse>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { EntitlementsService } from '@sailpoint/angular-sdk/entitlements';
import { Entitlementmetadatabulkupdatebyqueryrequest } from '@sailpoint/angular-sdk/entitlements';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(EntitlementsService);

  updateEntitlementsMetadataByQueryV1(): void {
    const entitlementmetadatabulkupdatebyqueryrequest: Entitlementmetadatabulkupdatebyqueryrequest = ; // Attribute metadata bulk update request body.
    this.api.updateEntitlementsMetadataByQueryV1({ entitlementmetadatabulkupdatebyqueryrequest: entitlementmetadatabulkupdatebyqueryrequest }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]