LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update python SDK docs: 15116515953

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-19 15:05:01 +00:00
parent d73e77c393
commit c8938e0862
279 changed files with 7276 additions and 7276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md
View File

@@ -15,18 +15,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Ignore Access Request Recommendation
[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation
[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark Viewed Access Request Recommendations
[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk Mark Viewed Access Request Recommendations
[**get-access-request-recommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations
[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List Ignored Access Request Recommendations
[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations
[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List Viewed Access Request Recommendations
[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Ignore access request recommendation
[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept access request recommendation
[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark viewed access request recommendations
[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk mark viewed access request recommendations
[**get-access-request-recommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity access request recommendations
[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List ignored access request recommendations
[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List accepted access request recommendations
[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List viewed access request recommendations
## add-access-request-recommendations-ignored-item
Ignore Access Request Recommendation
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-ignored-item)
@@ -75,7 +75,7 @@ with ApiClient(configuration) as api_client:
}''' # AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity.
try:
# Ignore Access Request Recommendation
# Ignore access request recommendation
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto)
results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
@@ -91,7 +91,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## add-access-request-recommendations-requested-item
Accept Access Request Recommendation
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-requested-item)
@@ -140,7 +140,7 @@ with ApiClient(configuration) as api_client:
}''' # AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity.
try:
# Accept Access Request Recommendation
# Accept access request recommendation
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto)
results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
@@ -156,7 +156,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## add-access-request-recommendations-viewed-item
Mark Viewed Access Request Recommendations
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-viewed-item)
@@ -205,7 +205,7 @@ with ApiClient(configuration) as api_client:
}''' # AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity.
try:
# Mark Viewed Access Request Recommendations
# Mark viewed access request recommendations
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto)
results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
@@ -221,7 +221,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## add-access-request-recommendations-viewed-items
Bulk Mark Viewed Access Request Recommendations
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-viewed-items)
@@ -264,7 +264,7 @@ with ApiClient(configuration) as api_client:
access_request_recommendation_action_item_dto = '''[sailpoint.beta.AccessRequestRecommendationActionItemDto()]''' # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity.
try:
# Bulk Mark Viewed Access Request Recommendations
# Bulk mark viewed access request recommendations
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto)
results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
@@ -281,7 +281,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-request-recommendations
Identity Access Request Recommendations
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations)
@@ -335,7 +335,7 @@ with ApiClient(configuration) as api_client:
sorters = 'access.name' # str | 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) # str | 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)
try:
# Identity Access Request Recommendations
# Identity access request recommendations
results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations()
# Below is a request that includes all optional parameters
@@ -352,7 +352,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-request-recommendations-ignored-items
List Ignored Access Request Recommendations
List ignored access request recommendations
This API returns the list of ignored access request recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-ignored-items)
@@ -402,7 +402,7 @@ with ApiClient(configuration) as api_client:
sorters = 'access.id' # str | 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) # str | 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)
try:
# List Ignored Access Request Recommendations
# List ignored access request recommendations
results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items()
# Below is a request that includes all optional parameters
@@ -419,7 +419,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-request-recommendations-requested-items
List Accepted Access Request Recommendations
List accepted access request recommendations
This API returns a list of requested access request recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-requested-items)
@@ -469,7 +469,7 @@ with ApiClient(configuration) as api_client:
sorters = 'access.id' # str | 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) # str | 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)
try:
# List Accepted Access Request Recommendations
# List accepted access request recommendations
results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items()
# Below is a request that includes all optional parameters
@@ -486,7 +486,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-request-recommendations-viewed-items
List Viewed Access Request Recommendations
List viewed access request recommendations
This API returns the list of viewed access request recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-viewed-items)
@@ -536,7 +536,7 @@ with ApiClient(configuration) as api_client:
sorters = 'access.id' # str | 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) # str | 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)
try:
# List Viewed Access Request Recommendations
# List viewed access request recommendations
results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items()
# Below is a request that includes all optional parameters