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

Update to powershell SDK docs: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRoleInsightsApi.md
View File

@@ -1,3 +1,4 @@
---
id: beta-role-insights
title: RoleInsights
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/role-insights
tags: ['SDK', 'Software Development Kit', 'RoleInsights', 'BetaRoleInsights']
---
# RoleInsights
@@ -28,9 +28,7 @@ Method | HTTP request | Description
[**Get-BetaRoleInsightsRequests**](#get-role-insights-requests) | **GET** `/role-insights/requests/{id}` | Returns metadata from prior request.
[**Get-BetaRoleInsightsSummary**](#get-role-insights-summary) | **GET** `/role-insights/summary` | Get role insights summary information
## create-role-insight-requests
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.
### Parameters
@@ -38,7 +36,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**RoleInsightsResponse**](../models/role-insights-response)
### Responses
@@ -52,13 +49,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Generate insights for roles
try {
New-BetaRoleInsightRequests
@@ -69,11 +67,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## download-role-insights-entitlements-changes
This endpoint returns the entitlement insights for a role.
### Parameters
@@ -84,7 +79,6 @@ Path | InsightId | **String** | True | The role insight id
Query | Filters | **String** | (optional) | 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: **name**: *sw* **description**: *sw*
### Return type
**String**
### Responses
@@ -97,7 +91,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/csv, application/json
@@ -106,7 +99,9 @@ Code | Description | Data Type
$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id
$Sorters = "identitiesWithAccess" # String | 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional)
$Filters = 'name sw "r"' # String | 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: **name**: *sw* **description**: *sw* (optional)
# Download entitlement insights for a role
try {
Invoke-BetaDownloadRoleInsightsEntitlementsChanges-BetaInsightId $InsightId
@@ -117,11 +112,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-changes-identities
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.
### Parameters
@@ -137,7 +129,6 @@ Path | EntitlementId | **String** | True | The entitlement id
Query | Filters | **String** | (optional) | 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: **name**: *sw*
### Return type
[**RoleInsightsIdentities[]**](../models/role-insights-identities)
### Responses
@@ -150,7 +141,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -164,7 +154,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Count = $true # 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Sorters = "name" # String | 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: **name** (optional)
$Filters = 'name sw "Jan"' # String | 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: **name**: *sw* (optional)
# Get identities for a suggested entitlement (for a role)
try {
Get-BetaEntitlementChangesIdentities-BetaInsightId $InsightId -BetaEntitlementId $EntitlementId
@@ -175,11 +167,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insight
This endpoint gets role insights information for a role.
### Parameters
@@ -188,7 +177,6 @@ Param Type | Name | Data Type | Required | Description
Path | InsightId | **String** | True | The role insight id
### Return type
[**RoleInsight**](../models/role-insight)
### Responses
@@ -201,14 +189,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id
# Get a single role insight
try {
Get-BetaRoleInsight-BetaInsightId $InsightId
@@ -219,11 +208,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights
This method returns detailed role insights for each role.
### Parameters
@@ -236,7 +222,6 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | 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: **name**: *sw* **ownerName**: *sw* **description**: *sw*
### Return type
[**RoleInsight[]**](../models/role-insight)
### Responses
@@ -249,7 +234,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -260,7 +244,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Count = $true # 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Sorters = "numberOfUpdates" # String | 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional)
$Filters = 'name sw "John"' # String | 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional)
# Get role insights
try {
Get-BetaRoleInsights
@@ -271,11 +257,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-current-entitlements
This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding.
### Parameters
@@ -285,7 +268,6 @@ Path | InsightId | **String** | True | The role insight id
Query | Filters | **String** | (optional) | 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: **name**: *sw* **description**: *sw*
### Return type
[**RoleInsightsEntitlement[]**](../models/role-insights-entitlement)
### Responses
@@ -298,7 +280,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -306,7 +287,9 @@ Code | Description | Data Type
```powershell
$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id
$Filters = 'name sw "r"' # String | 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: **name**: *sw* **description**: *sw* (optional)
# Get current entitlement for a role
try {
Get-BetaRoleInsightsCurrentEntitlements-BetaInsightId $InsightId
@@ -317,11 +300,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-entitlements-changes
This endpoint returns entitlement insights for a role.
### Parameters
@@ -332,7 +312,6 @@ Path | InsightId | **String** | True | The role insight id
Query | Filters | **String** | (optional) | 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: **name**: *sw* **description**: *sw*
### Return type
[**RoleInsightsEntitlementChanges[]**](../models/role-insights-entitlement-changes)
### Responses
@@ -345,7 +324,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -354,7 +332,9 @@ Code | Description | Data Type
$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id
$Sorters = "MySorters" # String | 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: **identitiesWithAccess, name** (optional)
$Filters = 'name sw "Admin"' # String | 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: **name**: *sw* **description**: *sw* (optional)
# Get entitlement insights for a role
try {
Get-BetaRoleInsightsEntitlementsChanges-BetaInsightId $InsightId
@@ -365,11 +345,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-requests
This endpoint returns details of a prior role insights request.
### Parameters
@@ -378,7 +355,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | The role insights request id
### Return type
[**RoleInsightsResponse**](../models/role-insights-response)
### Responses
@@ -392,14 +368,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id
# Returns metadata from prior request.
try {
Get-BetaRoleInsightsRequests-BetaId $Id
@@ -410,11 +387,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-insights-summary
This method returns high level summary information for role insights for a customer.
### Parameters
@@ -422,7 +396,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**RoleInsightsSummary**](../models/role-insights-summary)
### Responses
@@ -435,13 +408,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# Get role insights summary information
try {
Get-BetaRoleInsightsSummary
@@ -452,7 +426,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)