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

adding powershell sdk docs back

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-01-28 13:29:29 -05:00
parent 248e4afe6b
commit c69a78b807
2822 changed files with 201703 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningPotentialRoleSummary.md Normal file
View File

@@ -0,0 +1,67 @@
---
id: v2024-role-mining-potential-role-summary
title: RoleMiningPotentialRoleSummary
pagination_label: RoleMiningPotentialRoleSummary
sidebar_label: RoleMiningPotentialRoleSummary
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleSummary', 'V2024RoleMiningPotentialRoleSummary']
slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role-summary
tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummary', 'V2024RoleMiningPotentialRoleSummary']
---
# RoleMiningPotentialRoleSummary
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | Id of the potential role | [optional]
**Name** | Pointer to **String** | Name of the potential role | [optional]
**PotentialRoleRef** | Pointer to [**RoleMiningPotentialRoleRef**](role-mining-potential-role-ref) | | [optional]
**IdentityCount** | Pointer to **Int32** | The number of identities in a potential role. | [optional]
**EntitlementCount** | Pointer to **Int32** | The number of entitlements in a potential role. | [optional]
**IdentityGroupStatus** | Pointer to **String** | The status for this identity group which can be ""REQUESTED"" or ""OBTAINED"" | [optional]
**ProvisionState** | Pointer to [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional]
**RoleId** | Pointer to **String** | ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. | [optional]
**Density** | Pointer to **Int32** | The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. | [optional]
**Freshness** | Pointer to **Int32** | The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. | [optional]
**Quality** | Pointer to **Int32** | The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. | [optional]
**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional]
**CreatedBy** | Pointer to [**RoleMiningPotentialRoleSummaryCreatedBy**](role-mining-potential-role-summary-created-by) | | [optional]
**CreatedDate** | Pointer to **System.DateTime** | The date-time when this potential role was created. | [optional]
**Saved** | Pointer to **Boolean** | The potential role's saved status | [optional] [default to $false]
**Description** | Pointer to **String** | Description of the potential role | [optional]
**Session** | Pointer to [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional]
## Examples
- Prepare the resource
```powershell
$RoleMiningPotentialRoleSummary = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleSummary -Id e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 `
-Name Potential Role - e0cc5d `
-PotentialRoleRef null `
-IdentityCount 25 `
-EntitlementCount 15 `
-IdentityGroupStatus OBTAINED `
-ProvisionState null `
-RoleId 2a4be6fbcf3c4e66b95a0c15ffd591 `
-Density 90 `
-Freshness 70 `
-Quality 80 `
-Type null `
-CreatedBy null `
-CreatedDate null `
-Saved true `
-Description null `
-Session null
```
- Convert the resource to JSON
```powershell
$RoleMiningPotentialRoleSummary | ConvertTo-JSON
```
[[Back to top]](#)