mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
Update to powershell SDK docs: 13122455471
This commit is contained in:
developer-relations-sp
@@ -1,3 +1,4 @@
|
||||
|
||||
---
|
||||
id: certification-summaries
|
||||
title: CertificationSummaries
|
||||
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/certification-summaries
|
||||
tags: ['SDK', 'Software Development Kit', 'CertificationSummaries', 'CertificationSummaries']
|
||||
---
|
||||
|
||||
|
||||
# CertificationSummaries
|
||||
Use this API to implement certification summary functionality.
|
||||
With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness.
|
||||
@@ -37,9 +37,7 @@ Method | HTTP request | Description
|
||||
[**Get-IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification
|
||||
[**Get-IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity
|
||||
|
||||
|
||||
## get-identity-access-summaries
|
||||
|
||||
This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API.
|
||||
|
||||
### Parameters
|
||||
@@ -54,7 +52,6 @@ Path | Type | **String** | True | The type of access review item to retrieve
|
||||
Query | Sorters | **String** | (optional) | 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**
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccessSummary[]**](../models/access-summary)
|
||||
|
||||
### Responses
|
||||
@@ -69,7 +66,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
|
||||
|
||||
@@ -82,7 +78,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
|
||||
$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)
|
||||
$Filters = 'access.id eq "ef38f94347e94562b5bb8424a56397d8"' # 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional)
|
||||
$Sorters = "access.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: **access.name** (optional)
|
||||
|
||||
# Access Summaries
|
||||
|
||||
try {
|
||||
Get-IdentityAccessSummaries-Id $Id -Type $Type
|
||||
|
||||
@@ -93,11 +91,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-identity-decision-summary
|
||||
|
||||
This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API.
|
||||
|
||||
### Parameters
|
||||
@@ -107,7 +102,6 @@ Path | Id | **String** | True | The certification 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: **identitySummary.id**: *eq, in*
|
||||
|
||||
### Return type
|
||||
|
||||
[**IdentityCertDecisionSummary**](../models/identity-cert-decision-summary)
|
||||
|
||||
### Responses
|
||||
@@ -122,7 +116,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
|
||||
|
||||
@@ -130,7 +123,9 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID
|
||||
$Filters = 'identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"' # 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: **identitySummary.id**: *eq, in* (optional)
|
||||
|
||||
# Summary of Certification Decisions
|
||||
|
||||
try {
|
||||
Get-IdentityDecisionSummary-Id $Id
|
||||
|
||||
@@ -141,11 +136,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-identity-summaries
|
||||
|
||||
This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API.
|
||||
|
||||
### Parameters
|
||||
@@ -159,7 +151,6 @@ Path | Id | **String** | True | The identity campaign certification ID
|
||||
Query | Sorters | **String** | (optional) | 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**
|
||||
|
||||
### Return type
|
||||
|
||||
[**CertificationIdentitySummary[]**](../models/certification-identity-summary)
|
||||
|
||||
### Responses
|
||||
@@ -174,7 +165,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
|
||||
|
||||
@@ -186,7 +176,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
|
||||
$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)
|
||||
$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # 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: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional)
|
||||
$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)
|
||||
|
||||
# Identity Summaries for Campaign Certification
|
||||
|
||||
try {
|
||||
Get-IdentitySummaries-Id $Id
|
||||
|
||||
@@ -197,11 +189,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-identity-summary
|
||||
|
||||
This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API.
|
||||
|
||||
### Parameters
|
||||
@@ -211,7 +200,6 @@ Path | Id | **String** | True | The identity campaign certification ID
|
||||
Path | IdentitySummaryId | **String** | True | The identity summary ID
|
||||
|
||||
### Return type
|
||||
|
||||
[**CertificationIdentitySummary**](../models/certification-identity-summary)
|
||||
|
||||
### Responses
|
||||
@@ -226,7 +214,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
|
||||
|
||||
@@ -234,7 +221,9 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
|
||||
$IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID
|
||||
|
||||
# Summary for Identity
|
||||
|
||||
try {
|
||||
Get-IdentitySummary-Id $Id -IdentitySummaryId $IdentitySummaryId
|
||||
|
||||
@@ -245,7 +234,4 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user