Skip to main content

SuggestedEntitlementDescriptionService

Use this API to implement Suggested Entitlement Description (SED) functionality. SED functionality leverages the power of LLM to generate suggested entitlement descriptions. Refer to GenAI Entitlement Descriptions to learn more about SED in Identity Security Cloud (ISC).

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

MethodHTTP requestDescription
approve-bulk-entitlement-recommendations-v1POST /entitlement-recommendations/v1/bulk-approveBulk approve entitlement recommendations
create-auto-write-settings-v1POST /suggested-entitlement-descriptions/v1/auto-write-settingsCreate auto-write settings for SED
get-auto-write-settings-v1GET /suggested-entitlement-descriptions/v1/auto-write-settingsGet auto-write settings for SED
get-sed-batch-stats-v1GET /suggested-entitlement-description-batches/v1/{batchId}/statsSubmit sed batch stats request
get-sed-batches-v1GET /suggested-entitlement-description-batches/v1List Sed Batch Record
list-pending-entitlement-recommendation-approvals-v1GET /entitlement-recommendations/v1/pending-approvalsList pending entitlement recommendation approvals
list-privileged-entitlement-recommendations-v1GET /privileged-recommendations/v1List privileged entitlement recommendations
list-seds-v1GET /suggested-entitlement-descriptions/v1List suggested entitlement descriptions
patch-entitlement-recommendation-v1PATCH /entitlement-recommendations/v1/{id}Update an entitlement recommendation
patch-sed-v1PATCH /suggested-entitlement-descriptions/v1Patch suggested entitlement description
submit-entitlement-recommendations-assignment-v1POST /entitlement-recommendations/v1/assignAssign entitlement recommendations for review
submit-sed-approval-v1POST /suggested-entitlement-description-approvals/v1Submit bulk approval request
submit-sed-assignment-v1POST /suggested-entitlement-description-assignments/v1Submit sed assignment request
submit-sed-batch-request-v1POST /suggested-entitlement-description-batches/v1Submit sed batch request
update-auto-write-settings-v1PATCH /suggested-entitlement-descriptions/v1/auto-write-settingsUpdate auto-write settings for SED

approve-bulk-entitlement-recommendations-v1​

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Bulk approve entitlement recommendations Approve multiple entitlement recommendations in a single request. Each item in the request must include the recommendation ID and, depending on the record type, either an approved description (SED items) or an approved privilege level (privilege items). Returns a per-item result indicating success or failure.

API Spec

Parameters​

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

NameTypeDescriptionNotes
bulkApproveEntitlementRecommendationRequestBulkApproveEntitlementRecommendationRequestThe list of recommendation items to approve.
xSailPointExperimentalstringUse this header to enable this experimental API.[optional] [default to 'true']

Return type​

Observable<Array<BulkApproveEntitlementRecommendationResult>>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { SuggestedEntitlementDescriptionService } from '@sailpoint/angular-sdk/suggested_entitlement_description';
import { BulkApproveEntitlementRecommendationRequest } from '@sailpoint/angular-sdk/suggested_entitlement_description';

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

  approveBulkEntitlementRecommendationsV1(): void {
    const bulkApproveEntitlementRecommendationRequest: BulkApproveEntitlementRecommendationRequest = ; // The list of recommendation items to approve.
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.approveBulkEntitlementRecommendationsV1({ bulkApproveEntitlementRecommendationRequest: bulkApproveEntitlementRecommendationRequest }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

create-auto-write-settings-v1​

Create auto-write settings for SED Create the initial auto-write settings for a tenant. Returns 409 Conflict if settings already exist. Use PATCH to update existing settings.

API Spec

Parameters​

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

NameTypeDescriptionNotes
autoWriteSettingAutoWriteSettingAuto-write settings to create

Return type​

Observable<AutoWriteSettingResponse>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { SuggestedEntitlementDescriptionService } from '@sailpoint/angular-sdk/suggested_entitlement_description';
import { AutoWriteSetting } from '@sailpoint/angular-sdk/suggested_entitlement_description';

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

  createAutoWriteSettingsV1(): void {
    const autoWriteSetting: AutoWriteSetting = ; // Auto-write settings to create
    this.api.createAutoWriteSettingsV1({ autoWriteSetting: autoWriteSetting }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-auto-write-settings-v1​

Get auto-write settings for SED Get the current auto-write configuration for the tenant, including the enabled state and source include/exclude lists.

API Spec

Parameters​

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

This endpoint does not need any parameter.

Return type​

Observable<AutoWriteSettingResponse>

HTTP request headers​

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

Example​

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

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

  getAutoWriteSettingsV1(): void {
    this.api.getAutoWriteSettingsV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-sed-batch-stats-v1​

Submit sed batch stats request 'Submit Sed Batch Stats Request.

Submits batchId in the path param (e.g. {batchId}/stats). API responses with stats of the batchId.'

API Spec

Parameters​

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

NameTypeDescriptionNotes
batchIdstringBatch Id[default to undefined]

Return type​

Observable<SedBatchStats>

HTTP request headers​

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

Example​

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

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

  getSedBatchStatsV1(): void {
    const batchId: string = ; // Batch Id
    this.api.getSedBatchStatsV1({ batchId: batchId }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-sed-batches-v1​

List Sed Batch Record List Sed Batches. API responses with Sed Batch Records

API Spec

Parameters​

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

NameTypeDescriptionNotes
offsetnumberOffset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in V3 API Standard Collection Parameters. The offset value is record-based, not page-based, and the index starts at 0.[optional] [default to 0]
limitnumberLimit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in V3 API Standard Collection Parameters. If it is not specified, a default limit is used.[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. The standard syntax described in V3 API Standard Collection Parameters. 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.[optional] [default to false]
countOnlybooleanIf `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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array.[optional] [default to false]
statusstringBatch Status[optional] [default to undefined]

Return type​

Observable<Array<SedBatchRecord>>

HTTP request headers​

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

Example​

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

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

  getSedBatchesV1(): void {
    const offset: number = ; // Offset  Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional)
    const limit: number = ; // Limit  Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional)
    const count: boolean = ; // If &#x60;true&#x60; it will populate the &#x60;X-Total-Count&#x60; response header with the number of results that would be returned if &#x60;limit&#x60; and &#x60;offset&#x60; were ignored.  The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send &#x60;count&#x3D;true&#x60; if that value will not be used. (optional)
    const countOnly: boolean = ; // If &#x60;true&#x60; it will populate the &#x60;X-Total-Count&#x60; response header with the number of results that would be returned if &#x60;limit&#x60; and &#x60;offset&#x60; were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional)
    const status: string = ; // Batch Status (optional)
    this.api.getSedBatchesV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-pending-entitlement-recommendation-approvals-v1​

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

List pending entitlement recommendation approvals Returns a list of entitlement recommendations (SED and/or privilege) that are currently awaiting review or approval. Each record includes the recommendation type, entitlement details, and any AI-generated suggestions.

API Spec

Parameters​

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

NameTypeDescriptionNotes
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]
xSailPointExperimentalstringUse this header to enable this experimental API.[optional] [default to 'true']

Return type​

Observable<Array<EntitlementRecommendationRecord>>

HTTP request headers​

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

Example​

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

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

  listPendingEntitlementRecommendationApprovalsV1(): void {
    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 xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.listPendingEntitlementRecommendationApprovalsV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-privileged-entitlement-recommendations-v1​

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

List privileged entitlement recommendations Returns a list of privileged entitlement recommendation groups. Each group aggregates individual entitlement instances that share the same entitlement name and connector type, along with a recommendation score and instance count.

API Spec

Parameters​

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

NameTypeDescriptionNotes
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]
xSailPointExperimentalstringUse this header to enable this experimental API.[optional] [default to 'true']

Return type​

Observable<Array<PrivilegedRecommendationGroup>>

HTTP request headers​

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

Example​

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

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

  listPrivilegedEntitlementRecommendationsV1(): void {
    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 xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.listPrivilegedEntitlementRecommendationsV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-seds-v1​

List suggested entitlement descriptions List of Suggested Entitlement Descriptions (SED)

SED field descriptions:

batchId: the ID of the batch of entitlements that are submitted for description generation

displayName: the display name of the entitlement that we are generating a description for

sourceName: the name of the source associated with the entitlement that we are generating the description for

sourceId: the ID of the source associated with the entitlement that we are generating the description for

status: the status of the suggested entitlement description, valid status options: "requested", "suggested", "not_suggested", "failed", "assigned", "approved", "denied"

fullText: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name

API Spec

Parameters​

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

NameTypeDescriptionNotes
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]
filtersstringFilter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: batchId: eq, ne displayName: eq, ne, co sourceName: eq, ne, co sourceId: eq, ne status: eq, ne fullText: co[optional] [default to undefined]
sortersstringSort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: displayName, sourceName, status[optional] [default to undefined]
countOnlybooleanIf `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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array.[optional] [default to false]
requestedByAnyonebooleanBy default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested[optional] [default to false]
showPendingStatusOnlybooleanWill limit records to items that are in &quot;suggested&quot; or &quot;approved&quot; status[optional] [default to false]

Return type​

Observable<Array<Sed>>

HTTP request headers​

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

Example​

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

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

  listSedsV1(): void {
    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 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:  **batchId**: *eq, ne*  **displayName**: *eq, ne, co*  **sourceName**: *eq, ne, co*  **sourceId**: *eq, ne*  **status**: *eq, ne*  **fullText**: *co* (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: **displayName, sourceName, status** (optional)
    const countOnly: boolean = ; // If &#x60;true&#x60; it will populate the &#x60;X-Total-Count&#x60; response header with the number of results that would be returned if &#x60;limit&#x60; and &#x60;offset&#x60; were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional)
    const requestedByAnyone: boolean = ; // By default, the ListSeds API will only return items that you have requested to be generated.   This option will allow you to see all items that have been requested (optional)
    const showPendingStatusOnly: boolean = ; // Will limit records to items that are in \&quot;suggested\&quot; or \&quot;approved\&quot; status (optional)
    this.api.listSedsV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

patch-entitlement-recommendation-v1​

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Update an entitlement recommendation Partially update a single entitlement recommendation record by its ID. Use this endpoint to update the status, description, or privilege level of a specific SED or privilege recommendation.

API Spec

Parameters​

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

NameTypeDescriptionNotes
idstringThe unique identifier of the entitlement recommendation to update.[default to undefined]
jsonPatchOperationArray<JsonPatchOperation>The patch operations to apply to the entitlement recommendation record.
xSailPointExperimentalstringUse this header to enable this experimental API.[optional] [default to 'true']

Return type​

Observable<EntitlementRecommendationRecord>

HTTP request headers​

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

Example​

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

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

  patchEntitlementRecommendationV1(): void {
    const id: string = ; // The unique identifier of the entitlement recommendation to update.
    const jsonPatchOperation: Array<JsonPatchOperation> = ; // The patch operations to apply to the entitlement recommendation record.
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.patchEntitlementRecommendationV1({ id: id, jsonPatchOperation: jsonPatchOperation }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

patch-sed-v1​

Patch suggested entitlement description Patch Suggested Entitlement Description

API Spec

Parameters​

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

NameTypeDescriptionNotes
idstringid is sed id[default to undefined]
sedPatchArray<SedPatch>Sed Patch Request

Return type​

Observable<Sed>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { SuggestedEntitlementDescriptionService } from '@sailpoint/angular-sdk/suggested_entitlement_description';
import { SedPatch } from '@sailpoint/angular-sdk/suggested_entitlement_description';

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

  patchSedV1(): void {
    const id: string = ; // id is sed id
    const sedPatch: Array<SedPatch> = ; // Sed Patch Request
    this.api.patchSedV1({ id: id, sedPatch: sedPatch }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

submit-entitlement-recommendations-assignment-v1​

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Assign entitlement recommendations for review Assign a set of entitlement recommendation records to a reviewer. The assignee can be a specific identity, a governance group, or a role-based assignee such as source owner or entitlement owner. Returns a batch ID that can be used to track the assignment.

API Spec

Parameters​

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

NameTypeDescriptionNotes
entitlementRecommendationAssignRequestEntitlementRecommendationAssignRequestThe recommendation IDs and the target assignee.
xSailPointExperimentalstringUse this header to enable this experimental API.[optional] [default to 'true']

Return type​

Observable<EntitlementRecommendationAssignResult>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { SuggestedEntitlementDescriptionService } from '@sailpoint/angular-sdk/suggested_entitlement_description';
import { EntitlementRecommendationAssignRequest } from '@sailpoint/angular-sdk/suggested_entitlement_description';

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

  submitEntitlementRecommendationsAssignmentV1(): void {
    const entitlementRecommendationAssignRequest: EntitlementRecommendationAssignRequest = ; // The recommendation IDs and the target assignee.
    const xSailPointExperimental: string = ; // Use this header to enable this experimental API. (optional)
    this.api.submitEntitlementRecommendationsAssignmentV1({ entitlementRecommendationAssignRequest: entitlementRecommendationAssignRequest }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

submit-sed-approval-v1​

Submit bulk approval request Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status

API Spec

Parameters​

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

NameTypeDescriptionNotes
sedApprovalArray<SedApproval>Sed Approval

Return type​

Observable<Array<SedApprovalStatus>>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { SuggestedEntitlementDescriptionService } from '@sailpoint/angular-sdk/suggested_entitlement_description';
import { SedApproval } from '@sailpoint/angular-sdk/suggested_entitlement_description';

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

  submitSedApprovalV1(): void {
    const sedApproval: Array<SedApproval> = ; // Sed Approval
    this.api.submitSedApprovalV1({ sedApproval: sedApproval }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

submit-sed-assignment-v1​

Submit sed assignment request Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together

API Spec

Parameters​

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

NameTypeDescriptionNotes
sedAssignmentSedAssignmentSed Assignment Request

Return type​

Observable<SedAssignmentResponse>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { SuggestedEntitlementDescriptionService } from '@sailpoint/angular-sdk/suggested_entitlement_description';
import { SedAssignment } from '@sailpoint/angular-sdk/suggested_entitlement_description';

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

  submitSedAssignmentV1(): void {
    const sedAssignment: SedAssignment = ; // Sed Assignment Request
    this.api.submitSedAssignmentV1({ sedAssignment: sedAssignment }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

submit-sed-batch-request-v1​

Submit sed batch request Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together

API Spec

Parameters​

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

NameTypeDescriptionNotes
sedBatchRequestSedBatchRequestSed Batch Request[optional]

Return type​

Observable<SedBatchResponse>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { SuggestedEntitlementDescriptionService } from '@sailpoint/angular-sdk/suggested_entitlement_description';
import { SedBatchRequest } from '@sailpoint/angular-sdk/suggested_entitlement_description';

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

  submitSedBatchRequestV1(): void {
    const sedBatchRequest: SedBatchRequest = ; // Sed Batch Request (optional)
    this.api.submitSedBatchRequestV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

update-auto-write-settings-v1​

Update auto-write settings for SED Partially update the auto-write settings for a tenant using JSON Patch operations. Only the "replace" operation is supported. Returns 404 if no settings exist yet - use POST to create them first.

API Spec

Parameters​

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

NameTypeDescriptionNotes
autoWriteSettingPatchArray<AutoWriteSettingPatch>Patch operations for auto-write settings

Return type​

Observable<AutoWriteSettingResponse>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { SuggestedEntitlementDescriptionService } from '@sailpoint/angular-sdk/suggested_entitlement_description';
import { AutoWriteSettingPatch } from '@sailpoint/angular-sdk/suggested_entitlement_description';

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

  updateAutoWriteSettingsV1(): void {
    const autoWriteSettingPatch: Array<AutoWriteSettingPatch> = ; // Patch operations for auto-write settings
    this.api.updateAutoWriteSettingsV1({ autoWriteSettingPatch: autoWriteSettingPatch }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]