IAIAccessRequestRecommendationsApi
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| add-access-request-recommendations-ignored-item-v1 | POST /ai-access-request-recommendations/v1/ignored-items | Ignore access request recommendation |
| add-access-request-recommendations-requested-item-v1 | POST /ai-access-request-recommendations/v1/requested-items | Accept access request recommendation |
| add-access-request-recommendations-viewed-item-v1 | POST /ai-access-request-recommendations/v1/viewed-items | Mark viewed access request recommendations |
| add-access-request-recommendations-viewed-items-v1 | POST /ai-access-request-recommendations/v1/viewed-items/bulk-create | Bulk mark viewed access request recommendations |
| get-access-request-recommendations-config-v1 | GET /ai-access-request-recommendations/v1/config | Get access request recommendations config |
| get-access-request-recommendations-ignored-items-v1 | GET /ai-access-request-recommendations/v1/ignored-items | List ignored access request recommendations |
| get-access-request-recommendations-requested-items-v1 | GET /ai-access-request-recommendations/v1/requested-items | List accepted access request recommendations |
| get-access-request-recommendations-v1 | GET /ai-access-request-recommendations/v1 | Identity access request recommendations |
| get-access-request-recommendations-viewed-items-v1 | GET /ai-access-request-recommendations/v1/viewed-items | List viewed access request recommendations |
| set-access-request-recommendations-config-v1 | PUT /ai-access-request-recommendations/v1/config | Update access request recommendations config |
add-access-request-recommendations-ignored-item-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.
Ignore access request recommendation This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| accessrequestrecommendationactionitemdto | Accessrequestrecommendationactionitemdto | The recommended access item to ignore for an identity. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Accessrequestrecommendationactionitemresponsedto
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { IAIAccessRequestRecommendationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Accessrequestrecommendationactionitemdto } from 'sailpoint-api-client/dist/iai_access_request_recommendations/api';
const configuration = new Configuration();
const apiInstance = new IAIAccessRequestRecommendationsApi(configuration);
const accessrequestrecommendationactionitemdto: Accessrequestrecommendationactionitemdto = ; // The recommended access item to ignore for an identity.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.addAccessRequestRecommendationsIgnoredItemV1({ accessrequestrecommendationactionitemdto: accessrequestrecommendationactionitemdto });
console.log(result);
add-access-request-recommendations-requested-item-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.
Accept access request recommendation This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| accessrequestrecommendationactionitemdto | Accessrequestrecommendationactionitemdto | The recommended access item that was requested for an identity. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Accessrequestrecommendationactionitemresponsedto
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { IAIAccessRequestRecommendationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Accessrequestrecommendationactionitemdto } from 'sailpoint-api-client/dist/iai_access_request_recommendations/api';
const configuration = new Configuration();
const apiInstance = new IAIAccessRequestRecommendationsApi(configuration);
const accessrequestrecommendationactionitemdto: Accessrequestrecommendationactionitemdto = ; // The recommended access item that was requested for an identity.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.addAccessRequestRecommendationsRequestedItemV1({ accessrequestrecommendationactionitemdto: accessrequestrecommendationactionitemdto });
console.log(result);
add-access-request-recommendations-viewed-item-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.
Mark viewed access request recommendations This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| accessrequestrecommendationactionitemdto | Accessrequestrecommendationactionitemdto | The recommended access that was viewed for an identity. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Accessrequestrecommendationactionitemresponsedto
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { IAIAccessRequestRecommendationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Accessrequestrecommendationactionitemdto } from 'sailpoint-api-client/dist/iai_access_request_recommendations/api';
const configuration = new Configuration();
const apiInstance = new IAIAccessRequestRecommendationsApi(configuration);
const accessrequestrecommendationactionitemdto: Accessrequestrecommendationactionitemdto = ; // The recommended access that was viewed for an identity.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.addAccessRequestRecommendationsViewedItemV1({ accessrequestrecommendationactionitemdto: accessrequestrecommendationactionitemdto });
console.log(result);
add-access-request-recommendations-viewed-items-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.
Bulk mark viewed access request recommendations This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| accessrequestrecommendationactionitemdto | Array<Accessrequestrecommendationactionitemdto> | The recommended access items that were viewed for an identity. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Array<Accessrequestrecommendationactionitemresponsedto>
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { IAIAccessRequestRecommendationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Accessrequestrecommendationactionitemdto } from 'sailpoint-api-client/dist/iai_access_request_recommendations/api';
const configuration = new Configuration();
const apiInstance = new IAIAccessRequestRecommendationsApi(configuration);
const accessrequestrecommendationactionitemdto: Array<Accessrequestrecommendationactionitemdto> = ; // The recommended access items that were viewed for an identity.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.addAccessRequestRecommendationsViewedItemsV1({ accessrequestrecommendationactionitemdto: accessrequestrecommendationactionitemdto });
console.log(result);
get-access-request-recommendations-config-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.
Get access request recommendations config This API returns the configurations for Access Request Recommender for the tenant.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Accessrequestrecommendationconfigdto
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { IAIAccessRequestRecommendationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIAccessRequestRecommendationsApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getAccessRequestRecommendationsConfigV1({ });
console.log(result);
get-access-request-recommendations-ignored-items-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.
List ignored access request recommendations This API returns the list of ignored access request recommendations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | number | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [optional] [default to 250] |
| offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [optional] [default to 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. | [optional] [default to false] |
| filters | string | Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: access.id: eq, in access.type: eq, in identityId: eq, in | [optional] [default to undefined] |
| sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: access.id, access.type, identityId, timestamp | [optional] [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Array<Accessrequestrecommendationactionitemresponsedto>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { IAIAccessRequestRecommendationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIAccessRequestRecommendationsApi(configuration);
const limit: number = 250; // 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)
const offset: number = 0; // 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)
const count: boolean = true; // 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)
const filters: string = identityId eq "2c9180846b0a0583016b299f210c1314"; // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
const sorters: string = access.id; // 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: **access.id, access.type, identityId, timestamp** (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getAccessRequestRecommendationsIgnoredItemsV1({ });
console.log(result);
get-access-request-recommendations-requested-items-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.
List accepted access request recommendations This API returns a list of requested access request recommendations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | number | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [optional] [default to 250] |
| offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [optional] [default to 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. | [optional] [default to false] |
| filters | string | Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: access.id: eq, in access.type: eq, in identityId: eq, in | [optional] [default to undefined] |
| sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: access.id, access.type, identityId, timestamp | [optional] [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Array<Accessrequestrecommendationactionitemresponsedto>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { IAIAccessRequestRecommendationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIAccessRequestRecommendationsApi(configuration);
const limit: number = 250; // 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)
const offset: number = 0; // 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)
const count: boolean = true; // 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)
const filters: string = access.id eq "2c9180846b0a0583016b299f210c1314"; // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
const sorters: string = access.id; // 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: **access.id, access.type, identityId, timestamp** (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getAccessRequestRecommendationsRequestedItemsV1({ });
console.log(result);
get-access-request-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.
Identity access request recommendations This API returns the access request recommendations for the specified identity. The default identity is me which indicates the current user.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| identityId | string | Get access request recommendations for an identityId. me indicates the current user. | [optional] [default to 'me'] |
| limit | number | Max number of results to return. | [optional] [default to 15] |
| offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [optional] [default to 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. | [optional] [default to false] |
| includeTranslationMessages | boolean | If true it will populate a list of translation messages in the response. | [optional] [default to false] |
| filters | string | Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: access.name: co access.type: eq, in access.description: co, eq, in | [optional] [default to undefined] |
| sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: access.name, access.type By default the recommendations are sorted by highest confidence first. | [optional] [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Array<Accessrequestrecommendationitemdetail>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { IAIAccessRequestRecommendationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIAccessRequestRecommendationsApi(configuration);
const identityId: string = 2c91808570313110017040b06f344ec9; // Get access request recommendations for an identityId. *me* indicates the current user. (optional)
const limit: number = 15; // Max number of results to return. (optional)
const offset: number = 0; // 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)
const count: boolean = true; // 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)
const includeTranslationMessages: boolean = false; // If *true* it will populate a list of translation messages in the response. (optional)
const filters: string = access.name co "admin"; // 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional)
const sorters: string = access.name; // 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getAccessRequestRecommendationsV1({ });
console.log(result);
get-access-request-recommendations-viewed-items-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.
List viewed access request recommendations This API returns the list of viewed access request recommendations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | number | Max number of results to return. See V3 API Standard Collection Parameters for more information. | [optional] [default to 250] |
| offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | [optional] [default to 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. | [optional] [default to false] |
| filters | string | Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: access.id: eq, in access.type: eq, in identityId: eq, in | [optional] [default to undefined] |
| sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: access.id, access.type, identityId, timestamp | [optional] [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Array<Accessrequestrecommendationactionitemresponsedto>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { IAIAccessRequestRecommendationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new IAIAccessRequestRecommendationsApi(configuration);
const limit: number = 250; // 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)
const offset: number = 0; // 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)
const count: boolean = true; // 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)
const filters: string = access.id eq "2c9180846b0a0583016b299f210c1314"; // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
const sorters: string = access.id; // 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: **access.id, access.type, identityId, timestamp** (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getAccessRequestRecommendationsViewedItemsV1({ });
console.log(result);
set-access-request-recommendations-config-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.
Update access request recommendations config This API updates the configurations for Access Request Recommender for the tenant.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| accessrequestrecommendationconfigdto | Accessrequestrecommendationconfigdto | The desired configurations for Access Request Recommender for the tenant. | |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Accessrequestrecommendationconfigdto
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { IAIAccessRequestRecommendationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Accessrequestrecommendationconfigdto } from 'sailpoint-api-client/dist/iai_access_request_recommendations/api';
const configuration = new Configuration();
const apiInstance = new IAIAccessRequestRecommendationsApi(configuration);
const accessrequestrecommendationconfigdto: Accessrequestrecommendationconfigdto = ; // The desired configurations for Access Request Recommender for the tenant.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.setAccessRequestRecommendationsConfigV1({ accessrequestrecommendationconfigdto: accessrequestrecommendationconfigdto });
console.log(result);