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

188
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRoleMiningApi.md
View File

@@ -1,3 +1,4 @@
---
id: beta-iai-role-mining
title: IAIRoleMining
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/iai-role-mining
tags: ['SDK', 'Software Development Kit', 'IAIRoleMining', 'BetaIAIRoleMining']
---
# IAIRoleMining
@@ -44,9 +44,7 @@ Method | HTTP request | Description
[**Update-BetaRoleMiningSession**](#patch-role-mining-session) | **PATCH** `/role-mining-sessions/{sessionId}` | Patch a role mining session
[**Update-BetaEntitlementsPotentialRole**](#update-entitlements-potential-role) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements
## create-potential-role-provision-request
This method starts a job to provision a potential role
### Parameters
@@ -59,7 +57,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Body | RoleMiningPotentialRoleProvisionRequest | [**RoleMiningPotentialRoleProvisionRequest**](../models/role-mining-potential-role-provision-request) | (optional) | Required information to create a new role
### Return type
[**RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary)
### Responses
@@ -73,7 +70,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -90,7 +86,9 @@ $RoleMiningPotentialRoleProvisionRequest = @"{
"roleDescription" : "General access for accounting department",
"directlyAssignedEntitlements" : false
}"@
# Create request to provision a potential role into an actual role.
try {
New-BetaPotentialRoleProvisionRequest-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -101,11 +99,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-role-mining-sessions
This submits a create role mining session request to the role mining application.
### Parameters
@@ -114,7 +109,6 @@ Param Type | Name | Data Type | Required | Description
Body | RoleMiningSessionDto | [**RoleMiningSessionDto**](../models/role-mining-session-dto) | True | Role mining session parameters
### Return type
[**RoleMiningSessionResponse**](../models/role-mining-session-response)
### Responses
@@ -128,7 +122,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -166,7 +159,9 @@ $RoleMiningSessionDto = @"{
"identityCount" : 0,
"type" : "SPECIALIZED"
}"@
# Create a role mining session
try {
$Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto
New-BetaRoleMiningSessions-BetaRoleMiningSessionDto $Result
@@ -178,11 +173,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## download-role-mining-potential-role-zip
This endpoint downloads a completed export of information for a potential role in a role mining session.
### Parameters
@@ -193,7 +185,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Path | ExportId | **String** | True | The id of a previously run export job for this potential role
### Return type
**System.IO.FileInfo**
### Responses
@@ -206,7 +197,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/zip, application/json
@@ -215,7 +205,9 @@ Code | Description | Data Type
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
$PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session
$ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role
# Export (download) details for a potential role in a role mining session
try {
Invoke-BetaDownloadRoleMiningPotentialRoleZip-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId
@@ -226,11 +218,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-role-mining-potential-role
This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role.
### Parameters
@@ -240,7 +229,6 @@ Path | SessionId | **String** | True | The role mining session id
Path | PotentialRoleId | **String** | True | A potential role id in a role mining session
### Return type
**System.IO.FileInfo**
### Responses
@@ -253,7 +241,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/zip, application/json
@@ -261,7 +248,9 @@ Code | Description | Data Type
```powershell
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session
# Export (download) details for a potential role in a role mining session
try {
Export-BetaRoleMiningPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -272,11 +261,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-role-mining-potential-role-async
This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role.
### Parameters
@@ -287,7 +273,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Body | RoleMiningPotentialRoleExportRequest | [**RoleMiningPotentialRoleExportRequest**](../models/role-mining-potential-role-export-request) | (optional) |
### Return type
[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response)
### Responses
@@ -300,7 +285,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -312,7 +296,9 @@ $RoleMiningPotentialRoleExportRequest = @"{
"minEntitlementPopularity" : 0,
"includeCommonAccess" : true
}"@
# Asynchronously export details for a potential role in a role mining session and upload to S3
try {
Export-BetaRoleMiningPotentialRoleAsync-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -323,11 +309,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-role-mining-potential-role-status
This endpoint retrieves information about the current status of a potential role export.
### Parameters
@@ -338,7 +321,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Path | ExportId | **String** | True | The id of a previously run export job for this potential role
### Return type
[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response)
### Responses
@@ -351,7 +333,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
@@ -360,7 +341,9 @@ Code | Description | Data Type
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
$PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session
$ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role
# Retrieve status of a potential role export job
try {
Export-BetaRoleMiningPotentialRoleStatus-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId
@@ -371,11 +354,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-all-potential-role-summaries
Returns all potential role summaries that match the query parameters
### Parameters
@@ -388,7 +368,6 @@ Param Type | Name | Data Type | Required | Description
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type
[**RoleMiningPotentialRoleSummary[]**](../models/role-mining-potential-role-summary)
### Responses
@@ -402,7 +381,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
@@ -413,7 +391,9 @@ $Filters = '(createdByName co "int") and (createdById sw "2c9180907") and (type
$Offset = 0 # Int32 | 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) (default to 0)
$Limit = 250 # Int32 | 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) (default to 250)
$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)
# Retrieves all potential role summaries
try {
Get-BetaAllPotentialRoleSummaries
@@ -424,11 +404,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlement-distribution-potential-role
This method returns entitlement popularity distribution for a potential role in a role mining session.
### Parameters
@@ -439,7 +416,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Query | IncludeCommonAccess | **Boolean** | (optional) | Boolean determining whether common access entitlements will be included or not
### Return type
**System.Collections.Hashtable**
### Responses
@@ -452,7 +428,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
@@ -461,7 +436,9 @@ Code | Description | Data Type
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session
$IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional)
# Retrieves entitlement popularity distribution for a potential role in a role mining session
try {
Get-BetaEntitlementDistributionPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -472,11 +449,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-entitlements-potential-role
This method returns entitlements for a potential role in a role mining session.
### Parameters
@@ -492,7 +466,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type
[**RoleMiningEntitlement[]**](../models/role-mining-entitlement)
### Responses
@@ -506,7 +479,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
@@ -520,7 +492,9 @@ $Filters = 'applicationName sw "AD"' # String | Filter results using the standar
$Offset = 0 # Int32 | 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) (default to 0)
$Limit = 250 # Int32 | 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) (default to 250)
$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)
# Retrieves entitlements for a potential role in a role mining session
try {
Get-BetaEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -531,11 +505,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-excluded-entitlements-potential-role
This method returns excluded entitlements for a potential role in a role mining session.
### Parameters
@@ -550,7 +521,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type
[**RoleMiningEntitlement[]**](../models/role-mining-entitlement)
### Responses
@@ -563,7 +533,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
@@ -576,7 +545,9 @@ $Filters = 'applicationName sw "AD"' # String | Filter results using the standar
$Offset = 0 # Int32 | 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) (default to 0)
$Limit = 250 # Int32 | 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) (default to 250)
$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)
# Retrieves excluded entitlements for a potential role in a role mining session
try {
Get-BetaExcludedEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -587,11 +558,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identities-potential-role
This method returns identities for a potential role in a role mining session.
### Parameters
@@ -606,7 +574,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type
[**RoleMiningIdentity[]**](../models/role-mining-identity)
### Responses
@@ -619,7 +586,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
@@ -632,7 +598,9 @@ $Filters = 'MyFilters' # String | Filter results using the standard syntax descr
$Offset = 0 # Int32 | 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) (default to 0)
$Limit = 250 # Int32 | 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) (default to 250)
$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)
# Retrieves identities for a potential role in a role mining session
try {
Get-BetaIdentitiesPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -643,11 +611,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role
This method returns a specific potential role for a role mining session.
### Parameters
@@ -657,7 +622,6 @@ Path | SessionId | **String** | True | The role mining session id
Path | PotentialRoleId | **String** | True | A potential role id in a role mining session
### Return type
[**RoleMiningPotentialRole**](../models/role-mining-potential-role)
### Responses
@@ -671,7 +635,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
@@ -679,7 +642,9 @@ Code | Description | Data Type
```powershell
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session
# Retrieve potential role in session
try {
Get-BetaPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -690,11 +655,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-applications
This method returns the applications of a potential role for a role mining session.
### Parameters
@@ -708,7 +670,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type
[**RoleMiningPotentialRoleApplication[]**](../models/role-mining-potential-role-application)
### Responses
@@ -722,7 +683,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
@@ -734,7 +694,9 @@ $Filters = 'applicationName sw "test"' # String | Filter results using the stand
$Offset = 0 # Int32 | 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) (default to 0)
$Limit = 250 # Int32 | 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) (default to 250)
$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)
# Retrieves the applications of a potential role for a role mining session
try {
Get-BetaPotentialRoleApplications-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -745,11 +707,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-entitlements
This method returns the entitlements of a potential role for a role mining session.
### Parameters
@@ -763,7 +722,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type
[**RoleMiningPotentialRoleEntitlements[]**](../models/role-mining-potential-role-entitlements)
### Responses
@@ -777,7 +735,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
@@ -789,7 +746,9 @@ $Filters = 'entitlementRef.name sw "test"' # String | Filter results using the s
$Offset = 0 # Int32 | 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) (default to 0)
$Limit = 250 # Int32 | 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) (default to 250)
$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)
# Retrieves the entitlements of a potential role for a role mining session
try {
Get-BetaPotentialRoleEntitlements-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId
@@ -800,11 +759,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-source-identity-usage
This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role.
### Parameters
@@ -818,7 +774,6 @@ Path | SourceId | **String** | True | A source id
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type
[**RoleMiningPotentialRoleSourceUsage[]**](../models/role-mining-potential-role-source-usage)
### Responses
@@ -832,7 +787,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
@@ -844,7 +798,9 @@ $Sorters = "-usageCount" # String | Sort results using the standard syntax descr
$Offset = 0 # Int32 | 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) (default to 0)
$Limit = 250 # Int32 | 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) (default to 250)
$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)
# Retrieves potential role source usage
try {
Get-BetaPotentialRoleSourceIdentityUsage-BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId
@@ -855,11 +811,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-potential-role-summaries
This method returns the potential role summaries for a role mining session.
### Parameters
@@ -873,7 +826,6 @@ Path | SessionId | **String** | True | The role mining session id
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type
[**RoleMiningPotentialRoleSummary[]**](../models/role-mining-potential-role-summary)
### Responses
@@ -887,7 +839,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
@@ -899,7 +850,9 @@ $Filters = '(createdByName co "int")and (createdById sw "2c9180907")and (type eq
$Offset = 0 # Int32 | 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) (default to 0)
$Limit = 250 # Int32 | 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) (default to 250)
$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)
# Retrieve session's potential role summaries
try {
Get-BetaPotentialRoleSummaries-BetaSessionId $SessionId
@@ -910,11 +863,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-potential-role
This method returns a specific potential role.
### Parameters
@@ -923,7 +873,6 @@ Param Type | Name | Data Type | Required | Description
Path | PotentialRoleId | **String** | True | A potential role id
### Return type
[**RoleMiningPotentialRole**](../models/role-mining-potential-role)
### Responses
@@ -937,14 +886,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
$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id
# Retrieves a specific potential role
try {
Get-BetaRoleMiningPotentialRole-BetaPotentialRoleId $PotentialRoleId
@@ -955,11 +905,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-session
The method retrieves a role mining session.
### Parameters
@@ -968,7 +915,6 @@ Param Type | Name | Data Type | Required | Description
Path | SessionId | **String** | True | The role mining session id to be retrieved.
### Return type
[**RoleMiningSessionResponse**](../models/role-mining-session-response)
### Responses
@@ -983,14 +929,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
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved.
# Get a role mining session
try {
Get-BetaRoleMiningSession-BetaSessionId $SessionId
@@ -1001,11 +948,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-session-status
This method returns a role mining session status for a customer.
### Parameters
@@ -1014,7 +958,6 @@ Param Type | Name | Data Type | Required | Description
Path | SessionId | **String** | True | The role mining session id
### Return type
[**RoleMiningSessionStatus**](../models/role-mining-session-status)
### Responses
@@ -1027,14 +970,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
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
# Get role mining session status state
try {
Get-BetaRoleMiningSessionStatus-BetaSessionId $SessionId
@@ -1045,11 +989,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-role-mining-sessions
Returns all role mining sessions that match the query parameters
### Parameters
@@ -1062,7 +1003,6 @@ Param Type | Name | Data Type | Required | Description
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type
[**RoleMiningSessionResponse[]**](../models/role-mining-session-response)
### Responses
@@ -1076,7 +1016,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
@@ -1087,7 +1026,9 @@ $Sorters = "createdBy,createdDate" # String | Sort results using the standard sy
$Offset = 0 # Int32 | 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) (default to 0)
$Limit = 250 # Int32 | 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) (default to 250)
$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)
# Retrieves all role mining sessions
try {
Get-BetaRoleMiningSessions
@@ -1098,11 +1039,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-saved-potential-roles
This method returns all saved potential roles (draft roles).
### Parameters
@@ -1114,7 +1052,6 @@ Param Type | Name | Data Type | Required | Description
Query | Count | **Boolean** | (optional) (default to $false) | 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.
### Return type
[**RoleMiningSessionDraftRoleDto[]**](../models/role-mining-session-draft-role-dto)
### Responses
@@ -1128,7 +1065,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
@@ -1138,7 +1074,9 @@ $Sorters = "modified" # String | Sort results using the standard syntax describe
$Offset = 0 # Int32 | 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) (default to 0)
$Limit = 250 # Int32 | 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) (default to 250)
$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)
# Retrieves all saved potential roles
try {
Get-BetaSavedPotentialRoles
@@ -1149,11 +1087,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-potential-role
This method updates an existing potential role using the role mining session id and the potential role summary id.
The following fields can be modified:
@@ -1176,7 +1111,6 @@ Path | PotentialRoleId | **String** | True | The potential role summary id
Body | PatchPotentialRoleRequestInner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True |
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -1191,7 +1125,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
@@ -1199,10 +1132,11 @@ Code | Description | Data Type
```powershell
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id
$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id
# PatchPotentialRoleRequestInner[] |
$PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@
$PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ # PatchPotentialRoleRequestInner[] |
# Update a potential role in session
try {
$Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner
Update-BetaPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result
@@ -1214,11 +1148,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-role-mining-potential-role
This method updates an existing potential role.
The following fields can be modified:
@@ -1240,7 +1171,6 @@ Path | PotentialRoleId | **String** | True | The potential role summary id
Body | PatchPotentialRoleRequestInner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True |
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -1255,17 +1185,17 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id
# PatchPotentialRoleRequestInner[] |
$PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@
$PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ # PatchPotentialRoleRequestInner[] |
# Update a potential role
try {
$Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner
Update-BetaRoleMiningPotentialRole-BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result
@@ -1277,11 +1207,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-role-mining-session
The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated.
### Parameters
@@ -1291,7 +1218,6 @@ Path | SessionId | **String** | True | The role mining session id to be patch
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -1306,21 +1232,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched
# JsonPatchOperation[] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
}"@ # JsonPatchOperation[] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.
# Patch a role mining session
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-BetaRoleMiningSession-BetaSessionId $SessionId -BetaJsonPatchOperation $Result
@@ -1332,11 +1258,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-entitlements-potential-role
This endpoint adds or removes entitlements from an exclusion list for a potential role.
### Parameters
@@ -1347,7 +1270,6 @@ Path | PotentialRoleId | **String** | True | A potential role id in a role mi
Body | RoleMiningPotentialRoleEditEntitlements | [**RoleMiningPotentialRoleEditEntitlements**](../models/role-mining-potential-role-edit-entitlements) | True | Role mining session parameters
### Return type
[**RoleMiningPotentialRole**](../models/role-mining-potential-role)
### Responses
@@ -1360,7 +1282,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1372,7 +1293,9 @@ $RoleMiningPotentialRoleEditEntitlements = @"{
"ids" : [ "entId1", "entId2" ],
"exclude" : true
}"@
# Edit entitlements for a potential role to exclude some entitlements
try {
$Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements
Update-BetaEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result
@@ -1384,7 +1307,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)