Skip to main content

SuggestedEntitlementDescription

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).

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

MethodHTTP requestDescription
Approve-BulkEntitlementRecommendationsV1POST /entitlement-recommendations/v1/bulk-approveBulk approve entitlement recommendations
New-AutoWriteSettingsV1POST /suggested-entitlement-descriptions/v1/auto-write-settingsCreate auto-write settings for SED
Get-AutoWriteSettingsV1GET /suggested-entitlement-descriptions/v1/auto-write-settingsGet auto-write settings for SED
Get-SedBatchStatsV1GET /suggested-entitlement-description-batches/v1/{batchId}/statsSubmit sed batch stats request
Get-SedBatchesV1GET /suggested-entitlement-description-batches/v1List Sed Batch Record
Get-PendingEntitlementRecommendationApprovalsV1GET /entitlement-recommendations/v1/pending-approvalsList pending entitlement recommendation approvals
Get-PrivilegedEntitlementRecommendationsV1GET /privileged-recommendations/v1List privileged entitlement recommendations
Get-SedsV1GET /suggested-entitlement-descriptions/v1List suggested entitlement descriptions
Update-EntitlementRecommendationV1PATCH /entitlement-recommendations/v1/{id}Update an entitlement recommendation
Update-SedV1PATCH /suggested-entitlement-descriptions/v1Patch suggested entitlement description
Submit-EntitlementRecommendationsAssignmentV1POST /entitlement-recommendations/v1/assignAssign entitlement recommendations for review
Submit-SedApprovalV1POST /suggested-entitlement-description-approvals/v1Submit bulk approval request
Submit-SedAssignmentV1POST /suggested-entitlement-description-assignments/v1Submit sed assignment request
Submit-SedBatchRequestV1POST /suggested-entitlement-description-batches/v1Submit sed batch request
Update-AutoWriteSettingsV1PATCH /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.

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​

Param TypeNameData TypeRequiredDescription
XSailPointExperimentalStringTrue (default to "true")Use this header to enable this experimental API.
BodyBulkApproveEntitlementRecommendationRequestBulkApproveEntitlementRecommendationRequestTrueThe list of recommendation items to approve.

Return type​

BulkApproveEntitlementRecommendationResult[]

Responses​

CodeDescriptionData Type
200Per-item approval results.BulkApproveEntitlementRecommendationResult[]
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$BulkApproveEntitlementRecommendationRequest = @"{
  "items" : [ {
    "id" : "79db50d4-723c-4aa0-a824-83c2205d82d1",
    "recordType" : "SED",
    "description" : "Provides access and permissions related to the Delinea Secret Server Cloud system."
  }, {
    "id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "recordType" : "privilege",
    "privilegeLevel" : "high"
  } ]
}"@

# Bulk approve entitlement recommendations

try {
    $Result = ConvertFrom-JsonToBulkApproveEntitlementRecommendationRequest -Json $BulkApproveEntitlementRecommendationRequest
    Approve-BulkEntitlementRecommendationsV1 -XSailPointExperimental $XSailPointExperimental -BulkApproveEntitlementRecommendationRequest $Result 
    
    # Below is a request that includes all optional parameters
    # Approve-BulkEntitlementRecommendationsV1 -XSailPointExperimental $XSailPointExperimental -BulkApproveEntitlementRecommendationRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BulkEntitlementRecommendationsV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

create-auto-write-settings-v1​

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​

Param TypeNameData TypeRequiredDescription
BodyAutoWriteSettingAutoWriteSettingTrueAuto-write settings to create

Return type​

AutoWriteSettingResponse

Responses​

CodeDescriptionData Type
201Auto-write settings created successfullyAutoWriteSettingResponse
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
409Conflict - Indicates that the request could not be processed because of conflict in the current state of the resource.CreateAutoWriteSettingsV1409Response
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$AutoWriteSetting = @"{
  "excludedSourceIds" : [ "2c91808a7813090a017814552e526350" ],
  "includedSourceIds" : [ "2c91808a7813090a017814552e526349", "2c91808a7813090a017814552e52634a" ],
  "enabled" : true
}"@

# Create auto-write settings for SED

try {
    $Result = ConvertFrom-JsonToAutoWriteSetting -Json $AutoWriteSetting
    New-AutoWriteSettingsV1 -AutoWriteSetting $Result 
    
    # Below is a request that includes all optional parameters
    # New-AutoWriteSettingsV1 -AutoWriteSetting $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AutoWriteSettingsV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-auto-write-settings-v1​

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

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription

Return type​

AutoWriteSettingResponse

Responses​

CodeDescriptionData Type
200Current auto-write settingsAutoWriteSettingResponse
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​


# Get auto-write settings for SED

try {
    Get-AutoWriteSettingsV1 
    
    # Below is a request that includes all optional parameters
    # Get-AutoWriteSettingsV1  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AutoWriteSettingsV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-sed-batch-stats-v1​

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

Param TypeNameData TypeRequiredDescription
PathBatchIdStringTrueBatch Id

Return type​

SedBatchStats

Responses​

CodeDescriptionData Type
200Stats of Sed batch.SedBatchStats
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id

# Submit sed batch stats request

try {
    Get-SedBatchStatsV1 -BatchId $BatchId 
    
    # Below is a request that includes all optional parameters
    # Get-SedBatchStatsV1 -BatchId $BatchId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SedBatchStatsV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-sed-batches-v1​

List Sed Batches. API responses with Sed Batch Records

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
QueryOffsetInt64(optional) (default to 0)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. The offset value is record-based, not page-based, and the index starts at 0.
QueryLimitInt64(optional) (default to 250)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. If it is not specified, a default limit is used.
QueryCountBoolean(optional) (default to $false)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. 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.
QueryCountOnlyBoolean(optional) (default to $false)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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array.
QueryStatusString(optional)Batch Status

Return type​

SedBatchRecord[]

Responses​

CodeDescriptionData Type
200List of Sed Batch RecordsSedBatchRecord[]
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$Offset = 0 # Int64 | 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) (default to 0)
$Limit = 250 # Int64 | 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) (default to 250)
$Count = $true # 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.  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 `count=true` if that value will not be used. (optional) (default to $false)
$CountOnly = $true # 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. 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)
$Status = "completed, failed, submitted, materialized, failed" # String | Batch Status (optional)

# List Sed Batch Record

try {
    Get-SedBatchesV1 
    
    # Below is a request that includes all optional parameters
    # Get-SedBatchesV1 -Offset $Offset -Limit $Limit -Count $Count -CountOnly $CountOnly -Status $Status  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SedBatchesV1"
    Write-Host $_.ErrorDetails
}

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

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​

Param TypeNameData TypeRequiredDescription
XSailPointExperimentalStringTrue (default to "true")Use this header to enable this experimental API.
QueryOffsetInt32(optional) (default to 0)Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
QueryLimitInt32(optional) (default to 250)Max number of results to return. See V3 API Standard Collection Parameters for more information.

Return type​

EntitlementRecommendationRecord[]

Responses​

CodeDescriptionData Type
200A list of pending entitlement recommendation records.EntitlementRecommendationRecord[]
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Offset = 0 # Int32 | 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) (default to 0)
$Limit = 250 # Int32 | 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) (default to 250)

# List pending entitlement recommendation approvals

try {
    Get-PendingEntitlementRecommendationApprovalsV1 -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-PendingEntitlementRecommendationApprovalsV1 -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingEntitlementRecommendationApprovalsV1"
    Write-Host $_.ErrorDetails
}

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

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​

Param TypeNameData TypeRequiredDescription
XSailPointExperimentalStringTrue (default to "true")Use this header to enable this experimental API.
QueryOffsetInt32(optional) (default to 0)Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
QueryLimitInt32(optional) (default to 250)Max number of results to return. See V3 API Standard Collection Parameters for more information.

Return type​

PrivilegedRecommendationGroup[]

Responses​

CodeDescriptionData Type
200A list of privileged recommendation groups.PrivilegedRecommendationGroup[]
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Offset = 0 # Int32 | 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) (default to 0)
$Limit = 250 # Int32 | 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) (default to 250)

# List privileged entitlement recommendations

try {
    Get-PrivilegedEntitlementRecommendationsV1 -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-PrivilegedEntitlementRecommendationsV1 -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PrivilegedEntitlementRecommendationsV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-seds-v1​

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​

Param TypeNameData TypeRequiredDescription
QueryLimitInt32(optional) (default to 250)Max number of results to return. See V3 API Standard Collection Parameters for more information.
QueryOffsetInt32(optional) (default to 0)Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
QueryCountBoolean(optional) (default to $false)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.
QueryFiltersString(optional)Filter 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
QuerySortersString(optional)Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: displayName, sourceName, status
QueryCountOnlyBoolean(optional) (default to $false)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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array.
QueryRequestedByAnyoneBoolean(optional) (default to $false)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
QueryShowPendingStatusOnlyBoolean(optional) (default to $false)Will limit records to items that are in ""suggested"" or ""approved"" status

Return type​

Sed[]

Responses​

CodeDescriptionData Type
200List of Suggested Entitlement DetailsSed[]
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$Limit = 250 # Int32 | 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) (default to 250)
$Offset = 0 # Int32 | 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) (default to 0)
$Count = $true # 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'displayName co "Read and Write"' # 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)
$Sorters = "sorters=displayName" # 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)
$CountOnly = $false # 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. 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)
$RequestedByAnyone = $false # 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) (default to $false)
$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false)

# List suggested entitlement descriptions

try {
    Get-SedsV1 
    
    # Below is a request that includes all optional parameters
    # Get-SedsV1 -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SedsV1"
    Write-Host $_.ErrorDetails
}

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

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​

Param TypeNameData TypeRequiredDescription
PathIdStringTrueThe unique identifier of the entitlement recommendation to update.
XSailPointExperimentalStringTrue (default to "true")Use this header to enable this experimental API.
BodyJsonPatchOperation[]JsonPatchOperationTrueThe patch operations to apply to the entitlement recommendation record.

Return type​

EntitlementRecommendationRecord

Responses​

CodeDescriptionData Type
200The updated entitlement recommendation record.EntitlementRecommendationRecord
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$Id = "79db50d4-723c-4aa0-a824-83c2205d82d1" # String | The unique identifier of the entitlement recommendation to update.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ # JsonPatchOperation[] | The patch operations to apply to the entitlement recommendation record.
 

# Update an entitlement recommendation

try {
    $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
    Update-EntitlementRecommendationV1 -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result 
    
    # Below is a request that includes all optional parameters
    # Update-EntitlementRecommendationV1 -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-EntitlementRecommendationV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

patch-sed-v1​

Patch Suggested Entitlement Description

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathIdStringTrueid is sed id
BodySedPatch[]SedPatchTrueSed Patch Request

Return type​

Sed

Responses​

CodeDescriptionData Type
200detail of patched sedSed
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id
 $SedPatch = @"{
  "op" : "replace",
  "path" : "status",
  "value" : "approved"
}"@ # SedPatch[] | Sed Patch Request
 

# Patch suggested entitlement description

try {
    $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch
    Update-SedV1 -Id $Id -SedPatch $Result 
    
    # Below is a request that includes all optional parameters
    # Update-SedV1 -Id $Id -SedPatch $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SedV1"
    Write-Host $_.ErrorDetails
}

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

Param TypeNameData TypeRequiredDescription
XSailPointExperimentalStringTrue (default to "true")Use this header to enable this experimental API.
BodyEntitlementRecommendationAssignRequestEntitlementRecommendationAssignRequestTrueThe recommendation IDs and the target assignee.

Return type​

EntitlementRecommendationAssignResult

Responses​

CodeDescriptionData Type
202Assignment queued successfully. Returns the batch ID for tracking.EntitlementRecommendationAssignResult
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementRecommendationAssignRequest = @"{
  "assignee" : {
    "type" : "IDENTITY",
    "value" : "2c91808a7f3b2e8a017f3c3e5f6d0099"
  },
  "items" : [ "79db50d4-723c-4aa0-a824-83c2205d82d1", "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ]
}"@

# Assign entitlement recommendations for review

try {
    $Result = ConvertFrom-JsonToEntitlementRecommendationAssignRequest -Json $EntitlementRecommendationAssignRequest
    Submit-EntitlementRecommendationsAssignmentV1 -XSailPointExperimental $XSailPointExperimental -EntitlementRecommendationAssignRequest $Result 
    
    # Below is a request that includes all optional parameters
    # Submit-EntitlementRecommendationsAssignmentV1 -XSailPointExperimental $XSailPointExperimental -EntitlementRecommendationAssignRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-EntitlementRecommendationsAssignmentV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

submit-sed-approval-v1​

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

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
BodySedApproval[]SedApprovalTrueSed Approval

Return type​

SedApprovalStatus[]

Responses​

CodeDescriptionData Type
200List of SED Approval StatusSedApprovalStatus[]
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

 $SedApproval = @"{
  "items" : "016629d1-1d25-463f-97f3-c6686846650"
}"@ # SedApproval[] | Sed Approval
 

# Submit bulk approval request

try {
    $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval
    Submit-SedApprovalV1 -SedApproval $Result 
    
    # Below is a request that includes all optional parameters
    # Submit-SedApprovalV1 -SedApproval $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-SedApprovalV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

submit-sed-assignment-v1​

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​

Param TypeNameData TypeRequiredDescription
BodySedAssignmentSedAssignmentTrueSed Assignment Request

Return type​

SedAssignmentResponse

Responses​

CodeDescriptionData Type
202Sed Assignment ResponseSedAssignmentResponse
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$SedAssignment = @"{
  "assignee" : {
    "type" : "SOURCE_OWNER",
    "value" : "016629d1-1d25-463f-97f3-c6686846650"
  },
  "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ]
}"@

# Submit sed assignment request

try {
    $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment
    Submit-SedAssignmentV1 -SedAssignment $Result 
    
    # Below is a request that includes all optional parameters
    # Submit-SedAssignmentV1 -SedAssignment $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-SedAssignmentV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

submit-sed-batch-request-v1​

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​

Param TypeNameData TypeRequiredDescription
BodySedBatchRequestSedBatchRequest(optional)Sed Batch Request

Return type​

SedBatchResponse

Responses​

CodeDescriptionData Type
200Sed Batch ResponseSedBatchResponse
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$SedBatchRequest = @"{
  "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
  "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
  "searchCriteria" : {
    "key" : {
      "indices" : [ "entitlements" ],
      "query" : {
        "query" : "status:active"
      },
      "textQuery" : {
        "terms" : [ "admin", "user" ],
        "matchAny" : true,
        "fields" : [ "role", "name" ]
      },
      "searchAfter" : [ "12345", "67890" ],
      "filters" : {
        "status" : {
          "type" : "TERMS",
          "terms" : [ "active", "inactive" ]
        }
      },
      "sort" : [ "name:asc", "createdAt:desc" ],
      "queryType" : "TEXT",
      "includeNested" : true
    }
  }
}"@

# Submit sed batch request

try {
    Submit-SedBatchRequestV1 
    
    # Below is a request that includes all optional parameters
    # Submit-SedBatchRequestV1 -SedBatchRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-SedBatchRequestV1"
    Write-Host $_.ErrorDetails
}

[Back to top]

update-auto-write-settings-v1​

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​

Param TypeNameData TypeRequiredDescription
BodyAutoWriteSettingPatch[]AutoWriteSettingPatchTruePatch operations for auto-write settings

Return type​

AutoWriteSettingResponse

Responses​

CodeDescriptionData Type
200Updated auto-write settingsAutoWriteSettingResponse
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.GetAutoWriteSettingsV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.GetAutoWriteSettingsV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

 $AutoWriteSettingPatch = @"{
  "op" : "replace",
  "path" : "/enabled",
  "value" : true
}"@ # AutoWriteSettingPatch[] | Patch operations for auto-write settings
 

# Update auto-write settings for SED

try {
    $Result = ConvertFrom-JsonToAutoWriteSettingPatch -Json $AutoWriteSettingPatch
    Update-AutoWriteSettingsV1 -AutoWriteSettingPatch $Result 
    
    # Below is a request that includes all optional parameters
    # Update-AutoWriteSettingsV1 -AutoWriteSettingPatch $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AutoWriteSettingsV1"
    Write-Host $_.ErrorDetails
}

[Back to top]