mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 20:37:46 +00:00
Update to powershell SDK docs: 13207859154
This commit is contained in:
developer-relations-sp
@@ -41,9 +41,12 @@ Method | HTTP request | Description
|
||||
[**Get-PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List
|
||||
[**Deny-AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval
|
||||
|
||||
|
||||
## approve-access-request
|
||||
Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-access-request)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -87,16 +90,19 @@ try {
|
||||
Approve-AccessRequest -ApprovalId $ApprovalId
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto
|
||||
# Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-AccessRequest"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## forward-access-request
|
||||
Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/forward-access-request)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -133,19 +139,22 @@ $ForwardApprovalDto = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto
|
||||
Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result
|
||||
Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $ForwardApprovalDto
|
||||
# Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ForwardAccessRequest"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-access-request-approval-summary
|
||||
Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-request-approval-summary)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -177,7 +186,7 @@ $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and tim
|
||||
# Get Access Requests Approvals Number
|
||||
|
||||
try {
|
||||
Get-AccessRequestApprovalSummary
|
||||
Get-AccessRequestApprovalSummary
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate
|
||||
@@ -187,9 +196,12 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-completed-approvals
|
||||
This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-completed-approvals)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -229,7 +241,7 @@ $Sorters = "modified" # String | Sort results using the standard syntax describe
|
||||
# Completed Access Request Approvals List
|
||||
|
||||
try {
|
||||
Get-CompletedApprovals
|
||||
Get-CompletedApprovals
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
||||
@@ -239,9 +251,12 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-pending-approvals
|
||||
This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-pending-approvals)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -249,7 +264,7 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in*
|
||||
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in*
|
||||
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified**
|
||||
|
||||
### Return type
|
||||
@@ -275,13 +290,13 @@ $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value r
|
||||
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
||||
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
||||
$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional)
|
||||
$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional)
|
||||
$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
|
||||
|
||||
# Pending Access Request Approvals List
|
||||
|
||||
try {
|
||||
Get-PendingApprovals
|
||||
Get-PendingApprovals
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
||||
@@ -291,9 +306,12 @@ try {
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## reject-access-request
|
||||
Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-access-request)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -335,10 +353,10 @@ $CommentDto = @"{
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto
|
||||
Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
|
||||
Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto
|
||||
# Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-AccessRequest"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
Reference in New Issue
Block a user