IAIRecommendations

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

Method	HTTP request	Description
Get-BetaRecommendations	POST /recommendations/request	Returns a Recommendation Based on Object
Get-BetaRecommendationsConfig	GET /recommendations/config	Get certification recommendation config values
Update-BetaRecommendationsConfig	PUT /recommendations/config	Update certification recommendation config values

get-recommendations

The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	RecommendationRequestDto	RecommendationRequestDto	True

Return type

RecommendationResponseDto

Responses

Code	Description	Data Type
200	The recommendations for a customer	RecommendationResponseDto
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessModelMetadataAttribute401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too 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.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$RecommendationRequestDto = @"{
  "prescribeMode" : false,
  "excludeInterpretations" : false,
  "requests" : [ {
    "item" : {
      "id" : "2c938083633d259901633d2623ec0375",
      "type" : "ENTITLEMENT"
    },
    "identityId" : "2c938083633d259901633d25c68c00fa"
  }, {
    "item" : {
      "id" : "2c938083633d259901633d2623ec0375",
      "type" : "ENTITLEMENT"
    },
    "identityId" : "2c938083633d259901633d25c68c00fa"
  } ],
  "includeTranslationMessages" : false,
  "includeDebugInformation" : true
}"@

# Returns a Recommendation Based on Object

try {
    $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto
    Get-BetaRecommendations -BetaRecommendationRequestDto $Result 
    
    # Below is a request that includes all optional parameters
    # Get-BetaRecommendations -BetaRecommendationRequestDto $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-recommendations-config

Retrieves configuration attributes used by certification recommendations.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description

Return type

RecommendationConfigDto

Responses

Code	Description	Data Type
200	Cert recommendation configuration attributes	RecommendationConfigDto
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessModelMetadataAttribute401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

# Get certification recommendation config values

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

[Back to top]

update-recommendations-config

Updates configuration attributes used by certification recommendations.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	RecommendationConfigDto	RecommendationConfigDto	True

Return type

RecommendationConfigDto

Responses

Code	Description	Data Type
200	Cert recommendation configuration attributes after update	RecommendationConfigDto
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessModelMetadataAttribute401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$RecommendationConfigDto = @"{
  "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ],
  "peerGroupPercentageThreshold" : 0.5,
  "runAutoSelectOnce" : false,
  "onlyTuneThreshold" : false
}"@

# Update certification recommendation config values

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

[Back to top]