IAIRecommendationsApi
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| get-recommendations-config-v1 | GET /recommendations/v1/config | Get certification recommendation config values |
| get-recommendations-v1 | POST /recommendations/v1/request | Returns recommendation based on object |
| update-recommendations-config-v1 | PUT /recommendations/v1/config | Update certification recommendation config values |
get-recommendations-config-v1
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.
Get certification recommendation config values Retrieves configuration attributes used by certification recommendations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Recommendationconfigdto
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { IAIRecommendationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIRecommendationsApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getRecommendationsConfigV1({ });
console.log(result);
get-recommendations-v1
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 recommendation based on object 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.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| recommendationrequestdto | Recommendationrequestdto | ||
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Recommendationresponsedto
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { IAIRecommendationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIRecommendationsApi(configuration);
const recommendationrequestdto: Recommendationrequestdto = ; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getRecommendationsV1({ recommendationrequestdto: recommendationrequestdto });
console.log(result);
update-recommendations-config-v1
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 certification recommendation config values Updates configuration attributes used by certification recommendations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| recommendationconfigdto | Recommendationconfigdto | ||
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Recommendationconfigdto
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { IAIRecommendationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIRecommendationsApi(configuration);
const recommendationconfigdto: Recommendationconfigdto = ; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.updateRecommendationsConfigV1({ recommendationconfigdto: recommendationconfigdto });
console.log(result);