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

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RoleInsightsApi.md
View File

@@ -27,9 +27,18 @@ Method | HTTP request | Description
[**Get-V2024RoleInsightsRequests**](#get-role-insights-requests) | **GET** `/role-insights/requests/{id}` | Returns metadata from prior request.
[**Get-V2024RoleInsightsSummary**](#get-role-insights-summary) | **GET** `/role-insights/summary` | Get role insights summary information
## create-role-insight-requests
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
:::warning 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.
:::
Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-role-insight-requests)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -59,19 +68,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Generate insights for roles
try {
New-V2024RoleInsightRequests -V2024XSailPointExperimental $XSailPointExperimental
New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024RoleInsightRequests -V2024XSailPointExperimental $XSailPointExperimental
# New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleInsightRequests"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## download-role-insights-entitlements-changes
:::warning 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.
:::
This endpoint returns the entitlement insights for a role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/download-role-insights-entitlements-changes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -106,19 +121,25 @@ $Filters = 'name sw "r"' # String | Filter results using the standard syntax des
# Download entitlement insights for a role
try {
Invoke-V2024DownloadRoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental
Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Invoke-V2024DownloadRoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters
# Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleInsightsEntitlementsChanges"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-changes-identities
:::warning 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.
:::
Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-changes-identities)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -163,19 +184,25 @@ $Filters = 'name sw "Jan"' # String | Filter results using the standard syntax d
# Get identities for a suggested entitlement (for a role)
try {
Get-V2024EntitlementChangesIdentities -V2024InsightId $InsightId -V2024EntitlementId $EntitlementId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EntitlementChangesIdentities -V2024InsightId $InsightId -V2024EntitlementId $EntitlementId -V2024XSailPointExperimental $XSailPointExperimental -V2024HasEntitlement $HasEntitlement -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChangesIdentities"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insight
:::warning 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.
:::
This endpoint gets role insights information for a role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insight)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -206,19 +233,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get a single role insight
try {
Get-V2024RoleInsight -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsight -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsight"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights
:::warning 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.
:::
This method returns detailed role insights for each role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -257,19 +290,25 @@ $Filters = 'name sw "John"' # String | Filter results using the standard syntax
# Get role insights
try {
Get-V2024RoleInsights -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleInsights -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsights -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024RoleInsights -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsights"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-current-entitlements
:::warning 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.
:::
This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-current-entitlements)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -302,19 +341,25 @@ $Filters = 'name sw "r"' # String | Filter results using the standard syntax des
# Get current entitlement for a role
try {
Get-V2024RoleInsightsCurrentEntitlements -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsightsCurrentEntitlements -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters
# Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsCurrentEntitlements"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-entitlements-changes
:::warning 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.
:::
This endpoint returns entitlement insights for a role.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-entitlements-changes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -349,19 +394,28 @@ $Filters = 'name sw "Admin"' # String | Filter results using the standard syntax
# Get entitlement insights for a role
try {
Get-V2024RoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters
# Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsEntitlementsChanges"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-requests
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
:::warning 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.
:::
This endpoint returns details of a prior role insights request.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-requests)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -393,19 +447,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Returns metadata from prior request.
try {
Get-V2024RoleInsightsRequests -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsightsRequests -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsRequests"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-summary
:::warning 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.
:::
This method returns high level summary information for role insights for a customer.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-summary)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -434,10 +494,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get role insights summary information
try {
Get-V2024RoleInsightsSummary -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsightsSummary -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsSummary"
Write-Host $_.ErrorDetails