LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 04:19:34 +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

14
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIconsApi.md
View File

@@ -22,9 +22,12 @@ Method | HTTP request | Description
[**Remove-BetaIcon**](#delete-icon) | **DELETE** `/icons/{objectType}/{objectId}` | Delete an icon
[**Set-BetaIcon**](#set-icon) | **PUT** `/icons/{objectType}/{objectId}` | Update an icon
## delete-icon
This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-icon)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -57,19 +60,22 @@ $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id.
# Delete an icon
try {
Remove-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId
Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId
# Below is a request that includes all optional parameters
# Remove-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId
# Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIcon"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-icon
This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/set-icon)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -104,10 +110,10 @@ $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png'
# Update an icon
try {
Set-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image
Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image
# Below is a request that includes all optional parameters
# Set-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image
# Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIcon"
Write-Host $_.ErrorDetails