Skip to main content

Retrieves the entitlements of a potential role for a role mining session

GET 

https://sailpoint.api.identitynow.com/beta/role-mining-sessions/:sessionId/potential-role-summaries/:potentialRoleId/entitlements

This method returns the entitlements of a potential role for a role mining session.

Request

Path Parameters

    sessionId stringrequired

    The role mining session id

    Example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb
    potentialRoleId stringrequired

    A potential role id in a role mining session

    Example: 62f28d91-7d9f-4d17-be15-666d5b41d77f

Query Parameters

    filters string

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

    Filtering is supported for the following fields and operators:

    entitlementRef.name: sw

    Example: entitlementRef.name sw "test"
    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
    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
    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

Responses

Succeeded. Returns the entitlements of a potential role for a role mining session.

Schema
  • Array [
  • idstring

    Id of the entitlement

    Example: {"id":"2c9180877212632a017228d5a796292c"}
    namestring

    Name of the entitlement

    Example: {"name":"LauncherTest2"}
  • ]

Authorization: oauth2

type: Personal Access Token
scopes: iai:access-modeling:read
user levels: ORG_ADMIN
package main

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

func main() {

url := "https://sailpoint.api.identitynow.com/beta/role-mining-sessions/:sessionId/potential-role-summaries/:potentialRoleId/entitlements"
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/beta
Auth
Parameters
— pathrequired
— pathrequired
— query
— query
— query
— query
ResponseClear

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