LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAICommonAccessApi.md
View File

@@ -21,9 +21,12 @@ Method | HTTP request | Description
[**Get-BetaCommonAccess**](#get-common-access) | **GET** `/common-access` | Get a paginated list of common access
[**Update-BetaCommonAccessStatusInBulk**](#update-common-access-status-in-bulk) | **POST** `/common-access/update-status` | Bulk update common access status
## create-common-access
This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-common-access)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -64,19 +67,22 @@ $CommonAccessItemRequest = @"{
try {
$Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest
New-BetaCommonAccess -BetaCommonAccessItemRequest $Result
New-BetaCommonAccess -BetaCommonAccessItemRequest $Result
# Below is a request that includes all optional parameters
# New-BetaCommonAccess -BetaCommonAccessItemRequest $CommonAccessItemRequest
# New-BetaCommonAccess -BetaCommonAccessItemRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCommonAccess"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-common-access
This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-common-access)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -113,19 +119,22 @@ $Sorters = "access.name" # String | Sort results using the standard syntax descr
# Get a paginated list of common access
try {
Get-BetaCommonAccess
Get-BetaCommonAccess
# Below is a request that includes all optional parameters
# Get-BetaCommonAccess -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters
# Get-BetaCommonAccess -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCommonAccess"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-common-access-status-in-bulk
This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update
[API Spec](https://developer.sailpoint.com/docs/api/beta/update-common-access-status-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -160,10 +169,10 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus
Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $Result
Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $Result
# Below is a request that includes all optional parameters
# Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $CommonAccessIDStatus
# Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCommonAccessStatusInBulk"
Write-Host $_.ErrorDetails