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]](#)
|
||||
|
||||
@@ -20,14 +20,77 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**Approve-V2025Approval**](#approve-approval) | **POST** `/generic-approvals/{id}/approve` | Post Approvals Approve
|
||||
[**Get-V2025Approval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get an approval
|
||||
[**Get-V2025Approvals**](#get-approvals) | **GET** `/generic-approvals` | Get approvals
|
||||
[**Deny-V2025Approval**](#reject-approval) | **POST** `/generic-approvals/{id}/reject` | Post Approvals Reject
|
||||
[**Update-V2025ApprovalsAttributes**](#update-approvals-attributes) | **POST** `/generic-approvals/{id}/attributes` | Post Approvals Attributes
|
||||
[**Update-V2025ApprovalsComments**](#update-approvals-comments) | **POST** `/generic-approvals/{id}/comments` | Post Approvals Comments
|
||||
[**Update-V2025ApprovalsReassign**](#update-approvals-reassign) | **POST** `/generic-approvals/{id}/reassign` | Post Approvals Reassign
|
||||
|
||||
|
||||
## approve-approval
|
||||
Currently this endpoint only supports Entitlement Description Approvals.
|
||||
Approves a specified approval request on behalf of the caller. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals. The approval request must be in a state that allows it to be approved.
|
||||
If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/approve-approval)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Approval ID that correlates to an existing approval request that a user wants to approve
|
||||
Body | ApprovalApproveRequest | [**ApprovalApproveRequest**](../models/approval-approve-request) | (optional) |
|
||||
|
||||
### 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. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to approve
|
||||
$ApprovalApproveRequest = @"{
|
||||
"comment" : "comment",
|
||||
"additionalAttributes" : {
|
||||
"additionalProp1" : "string",
|
||||
"additionalProp2" : "string",
|
||||
"additionalProp3" : "string"
|
||||
}
|
||||
}"@
|
||||
|
||||
# Post Approvals Approve
|
||||
|
||||
try {
|
||||
Approve-V2025Approval -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Approve-V2025Approval -Id $Id -ApprovalApproveRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025Approval"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-approval
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Currently this endpoint only supports Entitlement Description Approvals.
|
||||
Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-approval)
|
||||
@@ -75,21 +138,29 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-approvals
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. "Mine" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals.
|
||||
Absence of all query parameters will will default to mine=true.
|
||||
Currently this endpoint only supports Entitlement Description Approvals.
|
||||
Get a list of approvals. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals.
|
||||
Absence of all query parameters for non admins will will default to mine=true.
|
||||
Absence of all query parameters for admins will return all approvals in the org.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-approvals)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
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*
|
||||
Query | Mine | **Boolean** | (optional) (default to $false) | Returns the list of approvals for the current caller.
|
||||
Query | RequesterId | **String** | (optional) | Returns the list of approvals for a given requester ID. Must match the calling user's identity ID unless they are an admin.
|
||||
Query | RequesteeId | **String** | (optional) | Returns the list of approvals for a given requesteeId ID. Must match the calling user's identity ID unless they are an admin.
|
||||
Query | ApproverId | **String** | (optional) | Returns the list of approvals for a given approverId ID. Must match the calling user's identity ID unless they are an admin.
|
||||
Query | Count | **Boolean** | (optional) (default to $false) | Adds X-Total-Count to the header to give the amount of total approvals returned from the query.
|
||||
Query | CountOnly | **Boolean** | (optional) (default to $false) | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects.
|
||||
Query | IncludeComments | **Boolean** | (optional) (default to $false) | If set to true in the query, the approval requests returned will include comments.
|
||||
Query | IncludeApprovers | **Boolean** | (optional) (default to $false) | If set to true in the query, the approval requests returned will include approvers.
|
||||
Query | IncludeBatchInfo | **Boolean** | (optional) (default to $false) | If set to true in the query, the approval requests returned will include batch information.
|
||||
Query | IncludeBatchInfo2 | **Boolean** | (optional) (default to $false) | If set to true in the query, the approval requests returned will include batch 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: **status**: *eq* **referenceType**: *eq* **name**: *eq* **priority**: *eq* **type**: *eq* **medium**: *eq* **description**: *eq* **batchId**: *eq* **approvalId**: *eq* **tenantId**: *eq* **createdDate**: *eq* **dueDate**: *eq* **completedDate**: *eq* **search**: *eq* **referenceId**: *eq* **referenceName**: *eq* **requestedTargetType**: *eq* **requestedTargetRequestType**: *eq* **requestedTargetId**: *eq* **modifiedDate**: *eq* **requesterId**: *eq* **requesteeId**: *eq* **approverId**: *eq*
|
||||
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.
|
||||
|
||||
### Return type
|
||||
[**Approval[]**](../models/approval)
|
||||
@@ -97,7 +168,7 @@ Param Type | Name | Data Type | Required | Description
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of Approvals | Approval[]
|
||||
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. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
@@ -110,21 +181,246 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$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)
|
||||
$Mine = $true # Boolean | Returns the list of approvals for the current caller. (optional) (default to $false)
|
||||
$RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. Must match the calling user's identity ID unless they are an admin. (optional)
|
||||
$RequesteeId = "27e6334g757e481569df76323169db9sc" # String | Returns the list of approvals for a given requesteeId ID. Must match the calling user's identity ID unless they are an admin. (optional)
|
||||
$ApproverId = "37e6334g557e481569df7g2d3169db9sb" # String | Returns the list of approvals for a given approverId ID. Must match the calling user's identity ID unless they are an admin. (optional)
|
||||
$Count = $true # Boolean | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. (optional) (default to $false)
|
||||
$CountOnly = $true # Boolean | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. (optional) (default to $false)
|
||||
$IncludeComments = $true # Boolean | If set to true in the query, the approval requests returned will include comments. (optional) (default to $false)
|
||||
$IncludeApprovers = $true # Boolean | If set to true in the query, the approval requests returned will include approvers. (optional) (default to $false)
|
||||
$IncludeBatchInfo = $true # Boolean | If set to true in the query, the approval requests returned will include batch information. (optional) (default to $false)
|
||||
$IncludeBatchInfo2 = $true # Boolean | If set to true in the query, the approval requests returned will include batch information. (optional) (default to $false)
|
||||
$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* **name**: *eq* **priority**: *eq* **type**: *eq* **medium**: *eq* **description**: *eq* **batchId**: *eq* **approvalId**: *eq* **tenantId**: *eq* **createdDate**: *eq* **dueDate**: *eq* **completedDate**: *eq* **search**: *eq* **referenceId**: *eq* **referenceName**: *eq* **requestedTargetType**: *eq* **requestedTargetRequestType**: *eq* **requestedTargetId**: *eq* **modifiedDate**: *eq* **requesterId**: *eq* **requesteeId**: *eq* **approverId**: *eq* (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)
|
||||
|
||||
# Get approvals
|
||||
|
||||
try {
|
||||
Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental
|
||||
Get-V2025Approvals
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters
|
||||
# Get-V2025Approvals -Mine $Mine -RequesterId $RequesterId -RequesteeId $RequesteeId -ApproverId $ApproverId -Count $Count -CountOnly $CountOnly -IncludeComments $IncludeComments -IncludeApprovers $IncludeApprovers -IncludeBatchInfo $IncludeBatchInfo -IncludeBatchInfo2 $IncludeBatchInfo2 -Filters $Filters -Limit $Limit -Offset $Offset
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approvals"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## reject-approval
|
||||
Currently this endpoint only supports Entitlement Description Approvals.
|
||||
Rejects a specified approval request on behalf of the caller.
|
||||
If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/reject-approval)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Approval ID that correlates to an existing approval request that a user wants to reject.
|
||||
Body | ApprovalRejectRequest | [**ApprovalRejectRequest**](../models/approval-reject-request) | (optional) |
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
204 | No content - indicates the request was successful but there is no content to be returned in the response. |
|
||||
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. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to reject.
|
||||
$ApprovalRejectRequest = @"{
|
||||
"comment" : "string"
|
||||
}"@
|
||||
|
||||
# Post Approvals Reject
|
||||
|
||||
try {
|
||||
Deny-V2025Approval -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Deny-V2025Approval -Id $Id -ApprovalRejectRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025Approval"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-approvals-attributes
|
||||
Currently this endpoint only supports Entitlement Description Approvals.
|
||||
Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-approvals-attributes)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
|
||||
Body | ApprovalAttributesRequest | [**ApprovalAttributesRequest**](../models/approval-attributes-request) | True |
|
||||
|
||||
### 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. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
|
||||
$ApprovalAttributesRequest = @"{
|
||||
"removeAttributeKeys" : [ "string" ],
|
||||
"comment" : "comment",
|
||||
"additionalAttributes" : {
|
||||
"additionalProp1" : "string",
|
||||
"additionalProp2" : "string",
|
||||
"additionalProp3" : "string"
|
||||
}
|
||||
}"@
|
||||
|
||||
# Post Approvals Attributes
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToApprovalAttributesRequest -Json $ApprovalAttributesRequest
|
||||
Update-V2025ApprovalsAttributes -Id $Id -ApprovalAttributesRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2025ApprovalsAttributes -Id $Id -ApprovalAttributesRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ApprovalsAttributes"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-approvals-comments
|
||||
Currently this endpoint only supports Entitlement Description Approvals.
|
||||
Adds comments to a specified approval request.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-approvals-comments)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Approval ID that correlates to an existing approval request that a user wants to add a comment to.
|
||||
Body | ApprovalCommentsRequest | [**ApprovalCommentsRequest**](../models/approval-comments-request) | True |
|
||||
|
||||
### 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. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to add a comment to.
|
||||
$ApprovalCommentsRequest = @"{
|
||||
"comment" : "Approval comment."
|
||||
}"@
|
||||
|
||||
# Post Approvals Comments
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToApprovalCommentsRequest -Json $ApprovalCommentsRequest
|
||||
Update-V2025ApprovalsComments -Id $Id -ApprovalCommentsRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2025ApprovalsComments -Id $Id -ApprovalCommentsRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ApprovalsComments"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-approvals-reassign
|
||||
Currently this endpoint only supports Entitlement Description Approvals.
|
||||
Reassigns an approval request to another identity resulting in that identity being added as an authorized approver.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-approvals-reassign)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | Approval ID that correlates to an existing approval request that a user wants to reassign.
|
||||
Body | ApprovalReassignRequest | [**ApprovalReassignRequest**](../models/approval-reassign-request) | True |
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
204 | No content - indicates the request was successful but there is no content to be returned in the response. |
|
||||
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. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to reassign.
|
||||
$ApprovalReassignRequest = @"{
|
||||
"reassignTo" : "152354832eb6f8f539fd738592e19ec5",
|
||||
"comment" : "comment",
|
||||
"reassignFrom" : "384532516be25f8fdf935ce19e295837"
|
||||
}"@
|
||||
|
||||
# Post Approvals Reassign
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToApprovalReassignRequest -Json $ApprovalReassignRequest
|
||||
Update-V2025ApprovalsReassign -Id $Id -ApprovalReassignRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2025ApprovalsReassign -Id $Id -ApprovalReassignRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ApprovalsReassign"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,45 +16,69 @@ tags: ['SDK', 'Software Development Kit', 'Approval', 'V2025Approval']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ApprovalId** | **String** | The Approval ID | [optional]
|
||||
**Id** | **String** | The Approval ID | [optional]
|
||||
**TenantId** | **String** | The Tenant ID of the Approval | [optional]
|
||||
**Type** | **String** | The type of the approval, such as ENTITLEMENT_DESCRIPTIONS, CUSTOM_ACCESS_REQUEST_APPROVAL, GENERIC_APPROVAL | [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]
|
||||
**DueDate** | **String** | Date the approval is due | [optional]
|
||||
**EscalationStep** | **String** | Step in the escalation process. If set to 0, the approval is not escalated. If set to 1, the approval is escalated to the first approver in the escalation chain. | [optional]
|
||||
**SerialStep** | **Int64** | The serial step of the approval in the approval chain. For example, serialStep 1 is the first approval to action in an approval request chain. Parallel approvals are set to 0. | [optional]
|
||||
**IsEscalated** | **Boolean** | Whether or not the approval has been escalated. Will reset to false when the approval is actioned on. | [optional] [default to $false]
|
||||
**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]
|
||||
**ApprovalConfig** | [**ApprovalConfig**](approval-config) | The configuration of the approval, such as the approval criteria and whether it is a parallel or serial approval | [optional]
|
||||
**Description** | [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional]
|
||||
**Medium** | **Enum** [ "EMAIL", "SLACK", "TEAMS" ] | Signifies what medium to use when sending notifications (currently only email is utilized) | [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]
|
||||
**Requestee** | [**ApprovalIdentity**](approval-identity) | Object representation of the requestee of the approval | [optional]
|
||||
**Comments** | [**[]ApprovalComment1**](approval-comment1) | 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]
|
||||
**ApprovedBy** | [**[]ApprovalIdentityRecord**](approval-identity-record) | Array of approvers who have approved the approval | [optional]
|
||||
**RejectedBy** | [**[]ApprovalIdentityRecord**](approval-identity-record) | Array of approvers who have rejected the approval | [optional]
|
||||
**AssignedTo** | [**[]ApprovalIdentity**](approval-identity) | Array of identities that the approval request is currently assigned to/waiting on. For parallel approvals, this is set to all approvers left to approve. | [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]
|
||||
**ApprovalCriteria** | [**ApprovalApprovalCriteria**](approval-approval-criteria) | | [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]
|
||||
**ReassignmentHistory** | [**[]ApprovalReassignmentHistory**](approval-reassignment-history) | History of whom the approval request was assigned to | [optional]
|
||||
**StaticAttributes** | [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Field that can include any static additional info that may be needed by the service that the approval request originated from | [optional]
|
||||
**ModifiedDate** | **System.DateTime** | Date/time that the approval request was last updated | [optional]
|
||||
**RequestedTarget** | [**[]ApprovalRequestedTarget**](approval-requested-target) | RequestedTarget used to specify the actual object or target the approval request is for | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$Approval = Initialize-V2025Approval -ApprovalId 38453251-6be2-5f8f-df93-5ce19e295837 `
|
||||
$Approval = Initialize-V2025Approval -Id 38453251-6be2-5f8f-df93-5ce19e295837 `
|
||||
-TenantId 38453251-6be2-5f8f-df93-5ce19e295837 `
|
||||
-Type ENTITLEMENT_DESCRIPTIONS `
|
||||
-Approvers null `
|
||||
-CreatedDate 2023-04-12T23:20:50.52Z `
|
||||
-Type ENTITLEMENT_DESCRIPTIONS `
|
||||
-DueDate 2024-05-12T23:10:50.11Z `
|
||||
-EscalationStep 0 `
|
||||
-SerialStep 0 `
|
||||
-IsEscalated true `
|
||||
-Name null `
|
||||
-BatchRequest {batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100} `
|
||||
-ApprovalConfig null `
|
||||
-Description null `
|
||||
-Medium EMAIL `
|
||||
-Priority HIGH `
|
||||
-Requester {id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe} `
|
||||
-Requester null `
|
||||
-Requestee null `
|
||||
-Comments null `
|
||||
-ApprovedBy null `
|
||||
-RejectedBy null `
|
||||
-AssignedTo null `
|
||||
-CompletedDate 2023-04-12T23:20:50.52Z `
|
||||
-ApprovalCriteria SINGLE `
|
||||
-Status PENDING `
|
||||
-ApprovalCriteria null `
|
||||
-AdditionalAttributes { "llm_description": "generated description" } `
|
||||
-ReferenceData null
|
||||
-ReferenceData null `
|
||||
-ReassignmentHistory null `
|
||||
-StaticAttributes {serviceName=ApprovalService, requestType=AccessRequest, metadata={environment=production, region=us-east-1}} `
|
||||
-ModifiedDate 2023-10-01T12:34:56.789Z `
|
||||
-RequestedTarget null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2025-approval-approval-criteria
|
||||
title: ApprovalApprovalCriteria
|
||||
pagination_label: ApprovalApprovalCriteria
|
||||
sidebar_label: ApprovalApprovalCriteria
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalApprovalCriteria', 'V2025ApprovalApprovalCriteria']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-approval-criteria
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalApprovalCriteria', 'V2025ApprovalApprovalCriteria']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalApprovalCriteria
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **String** | Type of approval criteria, such as SERIAL or PARALLEL | [optional]
|
||||
**Approval** | [**ApprovalApprovalCriteriaApproval**](approval-approval-criteria-approval) | | [optional]
|
||||
**Rejection** | [**ApprovalApprovalCriteriaRejection**](approval-approval-criteria-rejection) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalApprovalCriteria = Initialize-V2025ApprovalApprovalCriteria -Type SERIAL `
|
||||
-Approval null `
|
||||
-Rejection null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalApprovalCriteria | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2025-approval-approval-criteria-approval
|
||||
title: ApprovalApprovalCriteriaApproval
|
||||
pagination_label: ApprovalApprovalCriteriaApproval
|
||||
sidebar_label: ApprovalApprovalCriteriaApproval
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalApprovalCriteriaApproval', 'V2025ApprovalApprovalCriteriaApproval']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-approval-criteria-approval
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalApprovalCriteriaApproval', 'V2025ApprovalApprovalCriteriaApproval']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalApprovalCriteriaApproval
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CalculationType** | **Enum** [ "COUNT", "PERCENT" ] | This defines what the field ""value"" will be used as, either a count or percentage of the total approvers that need to approve | [optional]
|
||||
**Value** | **Int64** | The value that needs to be met for the approval criteria | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalApprovalCriteriaApproval = Initialize-V2025ApprovalApprovalCriteriaApproval -CalculationType COUNT `
|
||||
-Value 70
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalApprovalCriteriaApproval | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2025-approval-approval-criteria-rejection
|
||||
title: ApprovalApprovalCriteriaRejection
|
||||
pagination_label: ApprovalApprovalCriteriaRejection
|
||||
sidebar_label: ApprovalApprovalCriteriaRejection
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalApprovalCriteriaRejection', 'V2025ApprovalApprovalCriteriaRejection']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-approval-criteria-rejection
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalApprovalCriteriaRejection', 'V2025ApprovalApprovalCriteriaRejection']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalApprovalCriteriaRejection
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CalculationType** | **Enum** [ "COUNT", "PERCENT" ] | This defines what the field ""value"" will be used as, either a count or percentage of the total approvers that need to reject | [optional]
|
||||
**Value** | **Int64** | The value that needs to be met for the rejection criteria | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalApprovalCriteriaRejection = Initialize-V2025ApprovalApprovalCriteriaRejection -CalculationType COUNT `
|
||||
-Value 30
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalApprovalCriteriaRejection | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2025-approval-approve-request
|
||||
title: ApprovalApproveRequest
|
||||
pagination_label: ApprovalApproveRequest
|
||||
sidebar_label: ApprovalApproveRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalApproveRequest', 'V2025ApprovalApproveRequest']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-approve-request
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalApproveRequest', 'V2025ApprovalApproveRequest']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalApproveRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AdditionalAttributes** | **map[string]String** | Additional attributes as key-value pairs that are not part of the standard schema but can be included for custom data. | [optional]
|
||||
**Comment** | **String** | Comment associated with the request. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalApproveRequest = Initialize-V2025ApprovalApproveRequest -AdditionalAttributes {additionalProp1=string, additionalProp2=string, additionalProp3=string} `
|
||||
-Comment comment
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalApproveRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2025-approval-attributes-request
|
||||
title: ApprovalAttributesRequest
|
||||
pagination_label: ApprovalAttributesRequest
|
||||
sidebar_label: ApprovalAttributesRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalAttributesRequest', 'V2025ApprovalAttributesRequest']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-attributes-request
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalAttributesRequest', 'V2025ApprovalAttributesRequest']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalAttributesRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AdditionalAttributes** | **map[string]String** | Additional attributes as key-value pairs that are not part of the standard schema but can be included for custom data. | [optional]
|
||||
**Comment** | **String** | Comment associated with the request. | [optional]
|
||||
**RemoveAttributeKeys** | **[]String** | List of attribute keys to be removed. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalAttributesRequest = Initialize-V2025ApprovalAttributesRequest -AdditionalAttributes {additionalProp1=string, additionalProp2=string, additionalProp3=string} `
|
||||
-Comment comment `
|
||||
-RemoveAttributeKeys [string]
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalAttributesRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -19,6 +19,7 @@ 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]
|
||||
**CommentId** | **String** | ID of the comment | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -26,7 +27,8 @@ Name | Type | Description | Notes
|
||||
```powershell
|
||||
$ApprovalComment1 = Initialize-V2025ApprovalComment1 -Author null `
|
||||
-Comment Looks good `
|
||||
-CreatedDate 2023-04-12T23:20:50.52Z
|
||||
-CreatedDate 2023-04-12T23:20:50.52Z `
|
||||
-CommentId 38453251-6be2-5f8f-df93-5ce19e295837
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2025-approval-comments-request
|
||||
title: ApprovalCommentsRequest
|
||||
pagination_label: ApprovalCommentsRequest
|
||||
sidebar_label: ApprovalCommentsRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalCommentsRequest', 'V2025ApprovalCommentsRequest']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-comments-request
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalCommentsRequest', 'V2025ApprovalCommentsRequest']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalCommentsRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Comment** | **String** | Comment associated with the request. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalCommentsRequest = Initialize-V2025ApprovalCommentsRequest -Comment Approval comment.
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalCommentsRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
id: v2025-approval-config
|
||||
title: ApprovalConfig
|
||||
pagination_label: ApprovalConfig
|
||||
sidebar_label: ApprovalConfig
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalConfig', 'V2025ApprovalConfig']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-config
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalConfig', 'V2025ApprovalConfig']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalConfig
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**TenantId** | **String** | Tenant ID of the approval configuration. | [optional]
|
||||
**Id** | **String** | ID of the approval configuration. | [optional]
|
||||
**Scope** | **String** | The type/scope of the configuration. Ie APPROVAL_REQUEST, DOMAIN_OBJECT, APPROVAL_TYPE, TENANT | [optional]
|
||||
**ReminderConfig** | [**ApprovalConfigReminderConfig**](approval-config-reminder-config) | | [optional]
|
||||
**EscalationConfig** | [**ApprovalConfigEscalationConfig**](approval-config-escalation-config) | | [optional]
|
||||
**TimeoutConfig** | [**ApprovalConfigTimeoutConfig**](approval-config-timeout-config) | | [optional]
|
||||
**CronTimezone** | [**ApprovalConfigCronTimezone**](approval-config-cron-timezone) | | [optional]
|
||||
**SerialChain** | [**[]ApprovalConfigSerialChainInner**](approval-config-serial-chain-inner) | If the approval request has an approvalCriteria of SERIAL this chain will be used to determine the assignment order. | [optional]
|
||||
**RequiresComment** | **Enum** [ "APPROVAL", "REJECTION", "ALL", "OFF" ] | Determines whether a comment is required when approving or rejecting the approval request. | [optional]
|
||||
**FallbackApprover** | [**ApprovalIdentity**](approval-identity) | Configuration for fallback approver. Used if the user cannot be found for whatever reason and escalation config does not exist. | [optional]
|
||||
**AutoApprove** | **Enum** [ "OFF", "DIRECT", "INDIRECT" ] | OFF will prevent the approval request from being assigned to the requester or requestee by assigning it to their manager instead. DIRECT will cause approval requests to be auto-approved when assigned directly and only to the requester. INDIRECT will auto-approve when the requester appears anywhere in the list of approvers, including in a governance group. This field will only be effective if requestedTarget.reauthRequired is set to false, otherwise the approval will have to be manually approved. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalConfig = Initialize-V2025ApprovalConfig -TenantId d3c10266-1a31-4acc-b01e-44a3d1c56615 `
|
||||
-Id 5804e7d6-e04b-400f-9fb8-dff894419a2f `
|
||||
-Scope APPROVAL_REQUEST `
|
||||
-ReminderConfig null `
|
||||
-EscalationConfig null `
|
||||
-TimeoutConfig null `
|
||||
-CronTimezone null `
|
||||
-SerialChain null `
|
||||
-RequiresComment ALL `
|
||||
-FallbackApprover null `
|
||||
-AutoApprove false
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalConfig | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2025-approval-config-cron-timezone
|
||||
title: ApprovalConfigCronTimezone
|
||||
pagination_label: ApprovalConfigCronTimezone
|
||||
sidebar_label: ApprovalConfigCronTimezone
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalConfigCronTimezone', 'V2025ApprovalConfigCronTimezone']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-config-cron-timezone
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalConfigCronTimezone', 'V2025ApprovalConfigCronTimezone']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalConfigCronTimezone
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Location** | **String** | Timezone location for cron schedules. | [optional]
|
||||
**Offset** | **String** | Timezone offset for cron schedules. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalConfigCronTimezone = Initialize-V2025ApprovalConfigCronTimezone -Location America/New_York `
|
||||
-Offset
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalConfigCronTimezone | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2025-approval-config-escalation-config
|
||||
title: ApprovalConfigEscalationConfig
|
||||
pagination_label: ApprovalConfigEscalationConfig
|
||||
sidebar_label: ApprovalConfigEscalationConfig
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalConfigEscalationConfig', 'V2025ApprovalConfigEscalationConfig']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-config-escalation-config
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalConfigEscalationConfig', 'V2025ApprovalConfigEscalationConfig']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalConfigEscalationConfig
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Enabled** | **Boolean** | Indicates if escalations are enabled. | [optional] [default to $false]
|
||||
**DaysUntilFirstEscalation** | **Int64** | Number of days until the first escalation. | [optional]
|
||||
**EscalationCronSchedule** | **String** | Cron schedule for escalations. | [optional]
|
||||
**EscalationChain** | [**[]ApprovalConfigEscalationConfigEscalationChainInner**](approval-config-escalation-config-escalation-chain-inner) | Escalation chain configuration. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalConfigEscalationConfig = Initialize-V2025ApprovalConfigEscalationConfig -Enabled true `
|
||||
-DaysUntilFirstEscalation 2 `
|
||||
-EscalationCronSchedule */5 * * * * `
|
||||
-EscalationChain null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalConfigEscalationConfig | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2025-approval-config-escalation-config-escalation-chain-inner
|
||||
title: ApprovalConfigEscalationConfigEscalationChainInner
|
||||
pagination_label: ApprovalConfigEscalationConfigEscalationChainInner
|
||||
sidebar_label: ApprovalConfigEscalationConfigEscalationChainInner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalConfigEscalationConfigEscalationChainInner', 'V2025ApprovalConfigEscalationConfigEscalationChainInner']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-config-escalation-config-escalation-chain-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalConfigEscalationConfigEscalationChainInner', 'V2025ApprovalConfigEscalationConfigEscalationChainInner']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalConfigEscalationConfigEscalationChainInner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ChainId** | **String** | ID of the escalation chain. | [optional]
|
||||
**Tier** | **Int64** | Starting at 1 defines the order in which the identities will get assigned | [optional]
|
||||
**IdentityId** | **String** | Identity ID in the escalation chain. | [optional]
|
||||
**IdentityType** | **String** | Type of identity in the escalation chain. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalConfigEscalationConfigEscalationChainInner = Initialize-V2025ApprovalConfigEscalationConfigEscalationChainInner -ChainId ef85d1a8-41ef-433a-8153-0b1f59e7b26a `
|
||||
-Tier 1 `
|
||||
-IdentityId fdfda352157d4cc79bb749953131b457 `
|
||||
-IdentityType IDENTITY
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalConfigEscalationConfigEscalationChainInner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2025-approval-config-reminder-config
|
||||
title: ApprovalConfigReminderConfig
|
||||
pagination_label: ApprovalConfigReminderConfig
|
||||
sidebar_label: ApprovalConfigReminderConfig
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalConfigReminderConfig', 'V2025ApprovalConfigReminderConfig']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-config-reminder-config
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalConfigReminderConfig', 'V2025ApprovalConfigReminderConfig']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalConfigReminderConfig
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Enabled** | **Boolean** | Indicates if reminders are enabled. | [optional] [default to $false]
|
||||
**DaysUntilFirstReminder** | **Int64** | Number of days until the first reminder. | [optional]
|
||||
**ReminderCronSchedule** | **String** | Cron schedule for reminders. | [optional]
|
||||
**MaxReminders** | **Int64** | Maximum number of reminders. Max is 20. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalConfigReminderConfig = Initialize-V2025ApprovalConfigReminderConfig -Enabled false `
|
||||
-DaysUntilFirstReminder 0 `
|
||||
-ReminderCronSchedule 1 1 1 1 1 `
|
||||
-MaxReminders 5
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalConfigReminderConfig | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2025-approval-config-serial-chain-inner
|
||||
title: ApprovalConfigSerialChainInner
|
||||
pagination_label: ApprovalConfigSerialChainInner
|
||||
sidebar_label: ApprovalConfigSerialChainInner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalConfigSerialChainInner', 'V2025ApprovalConfigSerialChainInner']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-config-serial-chain-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalConfigSerialChainInner', 'V2025ApprovalConfigSerialChainInner']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalConfigSerialChainInner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ChainId** | **String** | ID of the serial chain. | [optional]
|
||||
**Tier** | **Int64** | Starting at 1 defines the order in which the identities will get assigned | [optional]
|
||||
**IdentityId** | **String** | Identity ID in the serial chain. | [optional]
|
||||
**IdentityType** | **String** | Type of identity in the serial chain. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalConfigSerialChainInner = Initialize-V2025ApprovalConfigSerialChainInner -ChainId 23dc206e-2a9e-4f98-93db-8d6e342cca18 `
|
||||
-Tier 1 `
|
||||
-IdentityId 2c9180858090ea8801809a0465e829da `
|
||||
-IdentityType IDENTITY
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalConfigSerialChainInner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2025-approval-config-timeout-config
|
||||
title: ApprovalConfigTimeoutConfig
|
||||
pagination_label: ApprovalConfigTimeoutConfig
|
||||
sidebar_label: ApprovalConfigTimeoutConfig
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalConfigTimeoutConfig', 'V2025ApprovalConfigTimeoutConfig']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-config-timeout-config
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalConfigTimeoutConfig', 'V2025ApprovalConfigTimeoutConfig']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalConfigTimeoutConfig
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Enabled** | **Boolean** | Indicates if timeout is enabled. | [optional] [default to $false]
|
||||
**DaysUntilTimeout** | **Int64** | Number of days until approval request times out. Max value is 90. | [optional]
|
||||
**TimeoutResult** | **Enum** [ "EXPIRED", "APPROVED" ] | Result of timeout. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalConfigTimeoutConfig = Initialize-V2025ApprovalConfigTimeoutConfig -Enabled true `
|
||||
-DaysUntilTimeout 2 `
|
||||
-TimeoutResult EXPIRED
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalConfigTimeoutConfig | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,17 +16,25 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalIdentity', 'V2025ApprovalIden
|
||||
|
||||
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]
|
||||
**Email** | **String** | Email address. | [optional]
|
||||
**IdentityID** | **String** | Identity ID. | [optional]
|
||||
**Members** | [**[]ApprovalIdentityMembersInner**](approval-identity-members-inner) | List of members of a governance group. Will be omitted if the identity is not a governance group. | [optional]
|
||||
**Name** | **String** | Name of the identity. | [optional]
|
||||
**OwnerOf** | [**[]ApprovalIdentityOwnerOfInner**](approval-identity-owner-of-inner) | List of owned items. For example, will show the items in which a ROLE_OWNER owns. Omitted if not an owner of anything. | [optional]
|
||||
**SerialOrder** | **Int64** | The serial step of the identity in the approval. For example serialOrder 1 is the first identity to action in an approval request chain. Parallel approvals are set to 0. | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY", "MANAGER_OF", "GOVERNANCE_GROUP", "SOURCE_OWNER", "ROLE_OWNER", "ACCESS_PROFILE_OWNER", "ENTITLEMENT_OWNER", "APPLICATION_OWNER" ] | Type of identity. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalIdentity = Initialize-V2025ApprovalIdentity -Id 85d173e7d57e496569df763231d6deb6a `
|
||||
-Type IDENTITY `
|
||||
-Name John Doe
|
||||
$ApprovalIdentity = Initialize-V2025ApprovalIdentity -Email mail@mail.com `
|
||||
-IdentityID 17e633e7d57e481569df76323169deb6a `
|
||||
-Members null `
|
||||
-Name Jim Bob `
|
||||
-OwnerOf null `
|
||||
-SerialOrder 0 `
|
||||
-Type IDENTITY
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2025-approval-identity-members-inner
|
||||
title: ApprovalIdentityMembersInner
|
||||
pagination_label: ApprovalIdentityMembersInner
|
||||
sidebar_label: ApprovalIdentityMembersInner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalIdentityMembersInner', 'V2025ApprovalIdentityMembersInner']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-identity-members-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalIdentityMembersInner', 'V2025ApprovalIdentityMembersInner']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalIdentityMembersInner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Email** | **String** | Email of the member. | [optional]
|
||||
**Id** | **String** | ID of the member. | [optional]
|
||||
**Name** | **String** | Name of the member. | [optional]
|
||||
**Type** | **String** | Type of the member. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalIdentityMembersInner = Initialize-V2025ApprovalIdentityMembersInner -Email mail@mail.com `
|
||||
-Id 17e633e7d57e481569df76323169deb6a `
|
||||
-Name Bob Neil `
|
||||
-Type IDENTITY
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalIdentityMembersInner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2025-approval-identity-owner-of-inner
|
||||
title: ApprovalIdentityOwnerOfInner
|
||||
pagination_label: ApprovalIdentityOwnerOfInner
|
||||
sidebar_label: ApprovalIdentityOwnerOfInner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalIdentityOwnerOfInner', 'V2025ApprovalIdentityOwnerOfInner']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-identity-owner-of-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalIdentityOwnerOfInner', 'V2025ApprovalIdentityOwnerOfInner']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalIdentityOwnerOfInner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | ID of the object that is owned. | [optional]
|
||||
**Name** | **String** | Name of the object that is owned. | [optional]
|
||||
**Type** | **String** | Type of the object that is owned. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalIdentityOwnerOfInner = Initialize-V2025ApprovalIdentityOwnerOfInner -Id string `
|
||||
-Name Access Request App `
|
||||
-Type APPLICATION
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalIdentityOwnerOfInner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
id: v2025-approval-identity-record
|
||||
title: ApprovalIdentityRecord
|
||||
pagination_label: ApprovalIdentityRecord
|
||||
sidebar_label: ApprovalIdentityRecord
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalIdentityRecord', 'V2025ApprovalIdentityRecord']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-identity-record
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalIdentityRecord', 'V2025ApprovalIdentityRecord']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalIdentityRecord
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IdentityID** | **String** | Identity ID. | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | Type of identity. | [optional]
|
||||
**Name** | **String** | Name of the identity. | [optional]
|
||||
**ActionedAs** | [**[]ApprovalReference**](approval-reference) | List of references representing actions taken by the identity. | [optional]
|
||||
**Members** | [**[]ApprovalReference**](approval-reference) | List of references representing members of the identity. | [optional]
|
||||
**DecisionDate** | **System.DateTime** | Date when the decision was made. | [optional]
|
||||
**Email** | **String** | Email associated with the identity. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalIdentityRecord = Initialize-V2025ApprovalIdentityRecord -IdentityID 17e633e7d57e481569df76323169deb6a `
|
||||
-Type IDENTITY `
|
||||
-Name Jim Bob `
|
||||
-ActionedAs null `
|
||||
-Members null `
|
||||
-DecisionDate 2023-04-12T23:20:50.520Z `
|
||||
-Email user@example.com
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalIdentityRecord | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2025-approval-reassign-request
|
||||
title: ApprovalReassignRequest
|
||||
pagination_label: ApprovalReassignRequest
|
||||
sidebar_label: ApprovalReassignRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalReassignRequest', 'V2025ApprovalReassignRequest']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-reassign-request
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalReassignRequest', 'V2025ApprovalReassignRequest']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalReassignRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Comment** | **String** | Comment associated with the reassign request. | [optional]
|
||||
**ReassignFrom** | **String** | Identity from which the approval is being reassigned. If left blank, and the approval is currently assigned to the user calling this endpoint, it will use the calling user's identity. If left blank, and the approval is not currently assigned to the user calling this endpoint, you need to be an admin, which would add the reassignTo as a new approver. | [optional]
|
||||
**ReassignTo** | **String** | Identity to which the approval is being reassigned. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalReassignRequest = Initialize-V2025ApprovalReassignRequest -Comment comment `
|
||||
-ReassignFrom 384532516be25f8fdf935ce19e295837 `
|
||||
-ReassignTo 152354832eb6f8f539fd738592e19ec5
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalReassignRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
id: v2025-approval-reassignment-history
|
||||
title: ApprovalReassignmentHistory
|
||||
pagination_label: ApprovalReassignmentHistory
|
||||
sidebar_label: ApprovalReassignmentHistory
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalReassignmentHistory', 'V2025ApprovalReassignmentHistory']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-reassignment-history
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalReassignmentHistory', 'V2025ApprovalReassignmentHistory']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalReassignmentHistory
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CommentID** | **String** | Unique identifier for the comment associated with the reassignment. | [optional]
|
||||
**ReassignedFrom** | [**ApprovalIdentity**](approval-identity) | | [optional]
|
||||
**ReassignedTo** | [**ApprovalIdentity**](approval-identity) | | [optional]
|
||||
**Reassigner** | [**ApprovalIdentity**](approval-identity) | | [optional]
|
||||
**ReassignmentDate** | **System.DateTime** | Date and time when the reassignment occurred. | [optional]
|
||||
**ReassignmentType** | **Enum** [ "ESCALATION", "MANUAL_REASSIGNMENT", "AUTO_REASSIGNMENT" ] | Type of reassignment, such as escalation or manual reassignment. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalReassignmentHistory = Initialize-V2025ApprovalReassignmentHistory -CommentID f47ac10b-58cc-4372-a567-0e02b2c3d479 `
|
||||
-ReassignedFrom null `
|
||||
-ReassignedTo null `
|
||||
-Reassigner null `
|
||||
-ReassignmentDate 2023-10-01T12:34:56.789Z `
|
||||
-ReassignmentType ESCALATION
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalReassignmentHistory | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -18,13 +18,19 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Id of the reference object | [optional]
|
||||
**Type** | **String** | What reference object does this ID correspond to | [optional]
|
||||
**Name** | **String** | Name of the reference object | [optional]
|
||||
**Email** | **String** | Email associated with the reference object | [optional]
|
||||
**SerialOrder** | **Int64** | The serial step of the identity in the approval. For example serialOrder 1 is the first identity to action in an approval request chain. Parallel approvals are set to 0. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalReference = Initialize-V2025ApprovalReference -Id 64012350-8fd9-4f6c-a170-1fe123683899 `
|
||||
-Type AccessRequestId
|
||||
-Type AccessRequestId `
|
||||
-Name Access Request `
|
||||
-Email user@example.com `
|
||||
-SerialOrder 0
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2025-approval-reject-request
|
||||
title: ApprovalRejectRequest
|
||||
pagination_label: ApprovalRejectRequest
|
||||
sidebar_label: ApprovalRejectRequest
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalRejectRequest', 'V2025ApprovalRejectRequest']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-reject-request
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalRejectRequest', 'V2025ApprovalRejectRequest']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalRejectRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Comment** | **String** | Comment associated with the reject request. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalRejectRequest = Initialize-V2025ApprovalRejectRequest -Comment string
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalRejectRequest | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
id: v2025-approval-requested-target
|
||||
title: ApprovalRequestedTarget
|
||||
pagination_label: ApprovalRequestedTarget
|
||||
sidebar_label: ApprovalRequestedTarget
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalRequestedTarget', 'V2025ApprovalRequestedTarget']
|
||||
slug: /tools/sdk/powershell/v2025/models/approval-requested-target
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalRequestedTarget', 'V2025ApprovalRequestedTarget']
|
||||
---
|
||||
|
||||
|
||||
# ApprovalRequestedTarget
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ForcedAuthSignature** | **String** | Signature required for forced authentication. | [optional]
|
||||
**Id** | **String** | ID of the requested target. | [optional]
|
||||
**Name** | **String** | Name of the requested target. | [optional]
|
||||
**ReauthRequired** | **Boolean** | Indicates if reauthentication is required. | [optional] [default to $false]
|
||||
**RemovalDate** | **System.DateTime** | Date when the target will be removed. | [optional]
|
||||
**RequestType** | **String** | Type of the request. | [optional]
|
||||
**TargetType** | **String** | Type of the target. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ApprovalRequestedTarget = Initialize-V2025ApprovalRequestedTarget -ForcedAuthSignature string `
|
||||
-Id string `
|
||||
-Name string `
|
||||
-ReauthRequired true `
|
||||
-RemovalDate 2025-07-07T18:10:13.687Z `
|
||||
-RequestType string `
|
||||
-TargetType string
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ApprovalRequestedTarget | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1406,46 +1406,6 @@
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaManualDiscoverApplicationsCsvTemplate"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /generic-approvals/{id}
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/beta/methods/approvals#get-approval
|
||||
source: |
|
||||
$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
|
||||
}
|
||||
- path: /generic-approvals
|
||||
method: GET
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/beta/methods/approvals#get-approvals
|
||||
source: |
|
||||
$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
|
||||
}
|
||||
- path: /source-apps
|
||||
method: POST
|
||||
xCodeSample:
|
||||
|
||||
@@ -1790,6 +1790,35 @@
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ManualDiscoverApplicationsCsvTemplate"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /generic-approvals/{id}/approve
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/approvals#approve-approval
|
||||
source: |
|
||||
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to approve
|
||||
$ApprovalApproveRequest = @"
|
||||
{
|
||||
"comment" : "comment",
|
||||
"additionalAttributes" : {
|
||||
"additionalProp1" : "string",
|
||||
"additionalProp2" : "string",
|
||||
"additionalProp3" : "string"
|
||||
}
|
||||
}
|
||||
"@
|
||||
|
||||
# Post Approvals Approve
|
||||
|
||||
try {
|
||||
Approve-V2025Approval -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Approve-V2025Approval -Id $Id -ApprovalApproveRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025Approval"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /generic-approvals/{id}
|
||||
method: GET
|
||||
xCodeSample:
|
||||
@@ -1816,22 +1845,138 @@
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/approvals#get-approvals
|
||||
source: |
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$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)
|
||||
$Mine = $true # Boolean | Returns the list of approvals for the current caller. (optional) (default to $false)
|
||||
$RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. Must match the calling user's identity ID unless they are an admin. (optional)
|
||||
$RequesteeId = "27e6334g757e481569df76323169db9sc" # String | Returns the list of approvals for a given requesteeId ID. Must match the calling user's identity ID unless they are an admin. (optional)
|
||||
$ApproverId = "37e6334g557e481569df7g2d3169db9sb" # String | Returns the list of approvals for a given approverId ID. Must match the calling user's identity ID unless they are an admin. (optional)
|
||||
$Count = $true # Boolean | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. (optional) (default to $false)
|
||||
$CountOnly = $true # Boolean | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. (optional) (default to $false)
|
||||
$IncludeComments = $true # Boolean | If set to true in the query, the approval requests returned will include comments. (optional) (default to $false)
|
||||
$IncludeApprovers = $true # Boolean | If set to true in the query, the approval requests returned will include approvers. (optional) (default to $false)
|
||||
$IncludeBatchInfo = $true # Boolean | If set to true in the query, the approval requests returned will include batch information. (optional) (default to $false)
|
||||
$IncludeBatchInfo2 = $true # Boolean | If set to true in the query, the approval requests returned will include batch information. (optional) (default to $false)
|
||||
$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* **name**: *eq* **priority**: *eq* **type**: *eq* **medium**: *eq* **description**: *eq* **batchId**: *eq* **approvalId**: *eq* **tenantId**: *eq* **createdDate**: *eq* **dueDate**: *eq* **completedDate**: *eq* **search**: *eq* **referenceId**: *eq* **referenceName**: *eq* **requestedTargetType**: *eq* **requestedTargetRequestType**: *eq* **requestedTargetId**: *eq* **modifiedDate**: *eq* **requesterId**: *eq* **requesteeId**: *eq* **approverId**: *eq* (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)
|
||||
|
||||
# Get approvals
|
||||
|
||||
try {
|
||||
Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental
|
||||
Get-V2025Approvals
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters
|
||||
# Get-V2025Approvals -Mine $Mine -RequesterId $RequesterId -RequesteeId $RequesteeId -ApproverId $ApproverId -Count $Count -CountOnly $CountOnly -IncludeComments $IncludeComments -IncludeApprovers $IncludeApprovers -IncludeBatchInfo $IncludeBatchInfo -IncludeBatchInfo2 $IncludeBatchInfo2 -Filters $Filters -Limit $Limit -Offset $Offset
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approvals"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /generic-approvals/{id}/reject
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/approvals#reject-approval
|
||||
source: |
|
||||
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to reject.
|
||||
$ApprovalRejectRequest = @"
|
||||
{
|
||||
"comment" : "string"
|
||||
}
|
||||
"@
|
||||
|
||||
# Post Approvals Reject
|
||||
|
||||
try {
|
||||
Deny-V2025Approval -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Deny-V2025Approval -Id $Id -ApprovalRejectRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025Approval"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /generic-approvals/{id}/attributes
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/approvals#update-approvals-attributes
|
||||
source: |
|
||||
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
|
||||
$ApprovalAttributesRequest = @"
|
||||
{
|
||||
"removeAttributeKeys" : [ "string" ],
|
||||
"comment" : "comment",
|
||||
"additionalAttributes" : {
|
||||
"additionalProp1" : "string",
|
||||
"additionalProp2" : "string",
|
||||
"additionalProp3" : "string"
|
||||
}
|
||||
}
|
||||
"@
|
||||
|
||||
# Post Approvals Attributes
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToApprovalAttributesRequest -Json $ApprovalAttributesRequest
|
||||
Update-V2025ApprovalsAttributes -Id $Id -ApprovalAttributesRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2025ApprovalsAttributes -Id $Id -ApprovalAttributesRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ApprovalsAttributes"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /generic-approvals/{id}/comments
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/approvals#update-approvals-comments
|
||||
source: |
|
||||
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to add a comment to.
|
||||
$ApprovalCommentsRequest = @"
|
||||
{
|
||||
"comment" : "Approval comment."
|
||||
}
|
||||
"@
|
||||
|
||||
# Post Approvals Comments
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToApprovalCommentsRequest -Json $ApprovalCommentsRequest
|
||||
Update-V2025ApprovalsComments -Id $Id -ApprovalCommentsRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2025ApprovalsComments -Id $Id -ApprovalCommentsRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ApprovalsComments"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /generic-approvals/{id}/reassign
|
||||
method: POST
|
||||
xCodeSample:
|
||||
- lang: PowerShell
|
||||
label: SDK_tools/sdk/powershell/v2025/methods/approvals#update-approvals-reassign
|
||||
source: |
|
||||
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | Approval ID that correlates to an existing approval request that a user wants to reassign.
|
||||
$ApprovalReassignRequest = @"
|
||||
{
|
||||
"reassignTo" : "152354832eb6f8f539fd738592e19ec5",
|
||||
"comment" : "comment",
|
||||
"reassignFrom" : "384532516be25f8fdf935ce19e295837"
|
||||
}
|
||||
"@
|
||||
|
||||
# Post Approvals Reassign
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToApprovalReassignRequest -Json $ApprovalReassignRequest
|
||||
Update-V2025ApprovalsReassign -Id $Id -ApprovalReassignRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2025ApprovalsReassign -Id $Id -ApprovalReassignRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ApprovalsReassign"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
- path: /source-apps
|
||||
method: POST
|
||||
xCodeSample:
|
||||
|
||||
Reference in New Issue
Block a user