Skip to main content

List Suggested Entitlement Descriptions

GET 

https://sailpoint.api.identitynow.com/v2025/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

Request

Query Parameters

    limit int32

    Possible values: <= 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Default value: 250
    Example: 250
    offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Default value: 0
    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Default value: false
    Example: true
    filters string

    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

    Example: displayName co "Read and Write"
    sorters string

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: displayName, sourceName, status

    Example: sorters=displayName
    count-only 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.

    Default value: false
    Example: count-only=true
    requested-by-anyone 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

    Default value: false
    Example: requested-by-anyone=true
    show-pending-status-only boolean

    Will limit records to items that are in "suggested" or "approved" status

    Default value: false
    Example: show-pending-status-only=true

Responses

List of Suggested Entitlement Details

Schema
  • Array [
  • Namestring

    name of the entitlement

    Example: BatchInvoiceProcessing
    approved_bystring

    entitlement approved by

    Example: 2c918086-76de-afbf-0176-f6d28f65565a
    approved_typestring

    entitlement approved type

    Example: admin
    approved_whendate-time

    entitlement approved then

    Example: 2024-03-22T16:32:16.308Z
    attributestring

    entitlement attribute

    Example: Role
    descriptionstring

    description of entitlement

    Example: This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable procedures.
    displayNamestring

    entitlement display name

    Example: AWS-Cloud-Billing
    iduuid

    sed id

    Example: ead281ee-12a9-40ac-9534-36b5d7d65d53
    sourceIdstring

    entitlement source id

    Example: 103f567b93ee49b991c40f9412f87643
    sourceNamestring

    entitlement source name

    Example: IDN Salesforce
    statusstring

    entitlement status

    Example: suggested
    suggestedDescriptionstring

    llm suggested entitlement description

    Example: This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable
    typestring

    entitlement type

    Example: group
    valuestring

    entitlement value

    Example: group
  • ]

Authorization: oauth2

type: Personal Access Token
scopes: idn:sed:read
user levels: ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://sailpoint.api.identitynow.com/v2025/suggested-entitlement-descriptions"
method := "GET"

client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)

if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Bearer <TOKEN>")

res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()

body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
Request Collapse all
Base URL
https://sailpoint.api.identitynow.com/v2025
Auth
Parameters
— query
— query
— query
— query
— query
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!