mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
Update PowerShell SDK docs: 16633294545
This commit is contained in:
developer-relations-sp
@@ -1,120 +0,0 @@
|
||||
---
|
||||
id: beta-approvals
|
||||
title: Approvals
|
||||
pagination_label: Approvals
|
||||
sidebar_label: Approvals
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Approvals', 'BetaApprovals']
|
||||
slug: /tools/sdk/powershell/beta/methods/approvals
|
||||
tags: ['SDK', 'Software Development Kit', 'Approvals', 'BetaApprovals']
|
||||
---
|
||||
|
||||
# Approvals
|
||||
Use this API to implement approval functionality. With this functionality in place, you can get generic approvals and modify them.
|
||||
|
||||
The main advantages this API has vs [Access Request Approvals](https://developer.sailpoint.com/docs/api/beta/access-request-approvals) are that you can use it to get generic approvals individually or in batches and make changes to those approvals.
|
||||
|
||||
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**Get-BetaApproval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get approval
|
||||
[**Get-BetaApprovals**](#get-approvals) | **GET** `/generic-approvals` | Get approvals
|
||||
|
||||
|
||||
## get-approval
|
||||
Get a single approval for a given approval ID. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and doesn't include access-request-approvals.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-approval)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | ID of the approval that to be returned.
|
||||
|
||||
### Return type
|
||||
[**Approval**](../models/approval)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Approval object | Approval
|
||||
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
|
||||
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that to be returned.
|
||||
|
||||
# Get approval
|
||||
|
||||
try {
|
||||
Get-BetaApproval -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-BetaApproval -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApproval"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-approvals
|
||||
Get a list of approvals, which can be filtered by requester ID, status, or reference type. You can use the "Mine" query parameter to return all approvals for the current approver. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals.
|
||||
Absence of all query parameters will will default to mine=true.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-approvals)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Query | Mine | **Boolean** | (optional) | Returns the list of approvals for the current caller.
|
||||
Query | RequesterId | **String** | (optional) | Returns the list of approvals for a given requester 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: **status**: *eq* **referenceType**: *eq*
|
||||
|
||||
### Return type
|
||||
[**Approval[]**](../models/approval)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of approvals. | Approval[]
|
||||
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
|
||||
$Mine = $true # Boolean | Returns the list of approvals for the current caller. (optional)
|
||||
$RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. (optional)
|
||||
$Filters = 'filters=status eq PENDING' # 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: **status**: *eq* **referenceType**: *eq* (optional)
|
||||
|
||||
# Get approvals
|
||||
|
||||
try {
|
||||
Get-BetaApprovals
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-BetaApprovals -Mine $Mine -RequesterId $RequesterId -Filters $Filters
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApprovals"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
@@ -1,67 +0,0 @@
|
||||
---
|
||||
id: beta-approval
|
||||
title: Approval
|
||||
pagination_label: Approval
|
||||
sidebar_label: Approval
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Approval', 'BetaApproval']
|
||||
slug: /tools/sdk/powershell/beta/models/approval
|
||||
tags: ['SDK', 'Software Development Kit', 'Approval', 'BetaApproval']
|
||||
---
|
||||
|
||||
|
||||
# Approval
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ApprovalId** | **String** | The Approval ID | [optional]
|
||||
**Approvers** | [**[]ApprovalIdentity**](approval-identity) | Object representation of an approver of an approval | [optional]
|
||||
**CreatedDate** | **String** | Date the approval was created | [optional]
|
||||
**Type** | **String** | Type of approval | [optional]
|
||||
**Name** | [**[]ApprovalName**](approval-name) | The name of the approval for a given locale | [optional]
|
||||
**BatchRequest** | [**ApprovalBatch**](approval-batch) | The name of the approval for a given locale | [optional]
|
||||
**Description** | [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional]
|
||||
**Priority** | **Enum** [ "HIGH", "MEDIUM", "LOW" ] | The priority of the approval | [optional]
|
||||
**Requester** | [**ApprovalIdentity**](approval-identity) | Object representation of the requester of the approval | [optional]
|
||||
**Comments** | [**[]ApprovalComment**](approval-comment) | Object representation of a comment on the approval | [optional]
|
||||
**ApprovedBy** | [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have approved the approval | [optional]
|
||||
**RejectedBy** | [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have rejected the approval | [optional]
|
||||
**CompletedDate** | **String** | Date the approval was completed | [optional]
|
||||
**ApprovalCriteria** | **Enum** [ "SINGLE", "DOUBLE", "TRIPLE", "QUARTER", "HALF", "ALL" ] | Criteria that needs to be met for an approval to be marked as approved | [optional]
|
||||
**Status** | **Enum** [ "PENDING", "APPROVED", "REJECTED" ] | The current status of the approval | [optional]
|
||||
**AdditionalAttributes** | **String** | Json string representing additional attributes known about the object to be approved. | [optional]
|
||||
**ReferenceData** | [**[]ApprovalReference**](approval-reference) | Reference data related to the approval | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$Approval = Initialize-BetaApproval -ApprovalId 38453251-6be2-5f8f-df93-5ce19e295837 `
|
||||
-Approvers null `
|
||||
-CreatedDate 2023-04-12T23:20:50.52Z `
|
||||
-Type ENTITLEMENT_DESCRIPTIONS `
|
||||
-Name null `
|
||||
-BatchRequest {batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100} `
|
||||
-Description null `
|
||||
-Priority HIGH `
|
||||
-Requester {id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe} `
|
||||
-Comments null `
|
||||
-ApprovedBy null `
|
||||
-RejectedBy null `
|
||||
-CompletedDate 2023-04-12T23:20:50.52Z `
|
||||
-ApprovalCriteria SINGLE `
|
||||
-Status PENDING `
|
||||
-AdditionalAttributes { "llm_description": "generated description" } `
|
||||
-ReferenceData null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Approval | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: beta-approval-batch
|
||||
title: ApprovalBatch
|
||||
pagination_label: ApprovalBatch
|
||||
sidebar_label: ApprovalBatch
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalBatch', 'BetaApprovalBatch']
|
||||
slug: /tools/sdk/powershell/beta/models/approval-batch
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalBatch', 'BetaApprovalBatch']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalBatch
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**BatchId** | **String** | ID of the batch | [optional]
|
||||
**BatchSize** | **Int64** | How many approvals are going to be in this batch. Defaults to 1 if not provided. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalBatch = Initialize-BetaApprovalBatch -BatchId 38453251-6be2-5f8f-df93-5ce19e295837 `
|
||||
-BatchSize 100
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalBatch | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: beta-approval-comment
|
||||
title: ApprovalComment
|
||||
pagination_label: ApprovalComment
|
||||
sidebar_label: ApprovalComment
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalComment', 'BetaApprovalComment']
|
||||
slug: /tools/sdk/powershell/beta/models/approval-comment
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'BetaApprovalComment']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalComment
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Author** | [**ApprovalIdentity**](approval-identity) | | [optional]
|
||||
**Comment** | **String** | Comment to be left on an approval | [optional]
|
||||
**CreatedDate** | **String** | Date the comment was created | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalComment = Initialize-BetaApprovalComment -Author null `
|
||||
-Comment Looks good `
|
||||
-CreatedDate 2023-04-12T23:20:50.52Z
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalComment | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: beta-approval-description
|
||||
title: ApprovalDescription
|
||||
pagination_label: ApprovalDescription
|
||||
sidebar_label: ApprovalDescription
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalDescription', 'BetaApprovalDescription']
|
||||
slug: /tools/sdk/powershell/beta/models/approval-description
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalDescription', 'BetaApprovalDescription']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalDescription
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Value** | **String** | The description of what the approval is asking for | [optional]
|
||||
**Locale** | **String** | What locale the description of the approval is using | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalDescription = Initialize-BetaApprovalDescription -Value This access allows viewing and editing of workflow resource `
|
||||
-Locale en_US
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalDescription | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: beta-approval-identity
|
||||
title: ApprovalIdentity
|
||||
pagination_label: ApprovalIdentity
|
||||
sidebar_label: ApprovalIdentity
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalIdentity', 'BetaApprovalIdentity']
|
||||
slug: /tools/sdk/powershell/beta/models/approval-identity
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalIdentity', 'BetaApprovalIdentity']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalIdentity
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The identity ID | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc | [optional]
|
||||
**Name** | **String** | Name of the identity | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalIdentity = Initialize-BetaApprovalIdentity -Id 85d173e7d57e496569df763231d6deb6a `
|
||||
-Type IDENTITY `
|
||||
-Name John Doe
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalIdentity | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: beta-approval-name
|
||||
title: ApprovalName
|
||||
pagination_label: ApprovalName
|
||||
sidebar_label: ApprovalName
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalName', 'BetaApprovalName']
|
||||
slug: /tools/sdk/powershell/beta/models/approval-name
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalName', 'BetaApprovalName']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalName
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Value** | **String** | Name of the approval | [optional]
|
||||
**Locale** | **String** | What locale the name of the approval is using | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalName = Initialize-BetaApprovalName -Value Audit DB Access `
|
||||
-Locale en_US
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalName | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
id: beta-approval-reference
|
||||
title: ApprovalReference
|
||||
pagination_label: ApprovalReference
|
||||
sidebar_label: ApprovalReference
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalReference', 'BetaApprovalReference']
|
||||
slug: /tools/sdk/powershell/beta/models/approval-reference
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalReference', 'BetaApprovalReference']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalReference
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Id of the reference object | [optional]
|
||||
**Type** | **String** | What reference object does this ID correspond to | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalReference = Initialize-BetaApprovalReference -Id 64012350-8fd9-4f6c-a170-1fe123683899 `
|
||||
-Type AccessRequestId
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalReference | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user