|
|
|
|
@@ -36,6 +36,7 @@ Method | HTTP request | Description
|
|
|
|
|
[**Get-BetaIdentityCertificationPendingTasks**](#get-identity-certification-pending-tasks) | **GET** `/certifications/{id}/tasks-pending` | Pending Certification Tasks
|
|
|
|
|
[**Get-BetaIdentityCertificationTaskStatus**](#get-identity-certification-task-status) | **GET** `/certifications/{id}/tasks/{taskId}` | Certification Task Status
|
|
|
|
|
[**Get-BetaCertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification
|
|
|
|
|
[**Get-BetaCertifications**](#list-certifications) | **GET** `/certifications` | Certifications by IDs
|
|
|
|
|
[**Submit-BetaReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@@ -251,6 +252,61 @@ try {
|
|
|
|
|
```
|
|
|
|
|
[[Back to top]](#)
|
|
|
|
|
|
|
|
|
|
## list-certifications
|
|
|
|
|
This API returns a list of certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned.
|
|
|
|
|
|
|
|
|
|
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-certifications)
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
Param Type | Name | Data Type | Required | Description
|
|
|
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
|
|
|
Query | ReviewerIdentitiy | **String** | (optional) | The ID of reviewer identity. *me* indicates the current user.
|
|
|
|
|
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
|
|
|
Query | Offset | **Int32** | (optional) (default to 0) | 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.
|
|
|
|
|
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.
|
|
|
|
|
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: **id**: *eq, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in*
|
|
|
|
|
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, due, signed**
|
|
|
|
|
|
|
|
|
|
### Return type
|
|
|
|
|
[**CertificationDto[]**](../models/certification-dto)
|
|
|
|
|
|
|
|
|
|
### Responses
|
|
|
|
|
Code | Description | Data Type
|
|
|
|
|
------------- | ------------- | -------------
|
|
|
|
|
200 | List of certifications | CertificationDto[]
|
|
|
|
|
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
|
|
|
|
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response
|
|
|
|
|
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
|
|
|
|
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response
|
|
|
|
|
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
|
|
|
|
|
|
|
|
|
### HTTP request headers
|
|
|
|
|
- **Content-Type**: Not defined
|
|
|
|
|
- **Accept**: application/json
|
|
|
|
|
|
|
|
|
|
### Example
|
|
|
|
|
```powershell
|
|
|
|
|
$ReviewerIdentitiy = "MyReviewerIdentitiy" # String | The ID of reviewer identity. *me* indicates the current user. (optional)
|
|
|
|
|
$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)
|
|
|
|
|
$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)
|
|
|
|
|
$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 = 'MyFilters' # 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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional)
|
|
|
|
|
$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: **name, due, signed** (optional)
|
|
|
|
|
|
|
|
|
|
# Certifications by IDs
|
|
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
Get-BetaCertifications
|
|
|
|
|
|
|
|
|
|
# Below is a request that includes all optional parameters
|
|
|
|
|
# Get-BetaCertifications -ReviewerIdentitiy $ReviewerIdentitiy -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
|
|
|
} catch {
|
|
|
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertifications"
|
|
|
|
|
Write-Host $_.ErrorDetails
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
[[Back to top]](#)
|
|
|
|
|
|
|
|
|
|
## submit-reassign-certs-async
|
|
|
|
|
:::caution deprecated
|
|
|
|
|
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
|
|
|
|
|
|
developer-relations-sp