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

Update to powershell SDK docs: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,3 +1,4 @@
---
id: beta-icons
title: Icons
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/icons
tags: ['SDK', 'Software Development Kit', 'Icons', 'BetaIcons']
---
# Icons
Use this API to implement functionality related to object icons (application icons for example).
With this functionality in place, administrators can set or remove an icon for specific object type for use throughout Identity Security Cloud.
@@ -23,19 +23,16 @@ 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.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | ObjectType | **String** | True | Object type. Available options ['application']
Path | ObjectType | **String** | True | Object type
Path | ObjectId | **String** | True | Object id.
### Return type
(empty response body)
### Responses
@@ -50,15 +47,16 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$ObjectType = "application" # String | Object type. Available options ['application']
$ObjectType = "application" # String | Object type
$ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id.
# Delete an icon
try {
Remove-BetaIcon-BetaObjectType $ObjectType -BetaObjectId $ObjectId
@@ -69,22 +67,18 @@ try {
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.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | ObjectType | **String** | True | Object type. Available options ['application']
Path | ObjectType | **String** | True | Object type
Path | ObjectId | **String** | True | Object id.
| Image | **System.IO.FileInfo** | True | file with icon. Allowed mime-types ['image/png', 'image/jpeg']
### Return type
[**SetIcon200Response**](../models/set-icon200-response)
### Responses
@@ -99,16 +93,17 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
### Example
```powershell
$ObjectType = "application" # String | Object type. Available options ['application']
$ObjectType = "application" # String | Object type
$ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id.
$Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg']
# Update an icon
try {
Set-BetaIcon-BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image
@@ -119,7 +114,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)