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

adding all powershell doc versions back

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-01-28 09:59:02 -05:00
parent ca4e98517f
commit f71193e0d5
1823 changed files with 130757 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

125
docs/tools/sdk/powershell/reference/v2024/Methods/V2024IconsApi.md Normal file
View File

@@ -0,0 +1,125 @@
---
id: v2024-icons
title: Icons
pagination_label: Icons
sidebar_label: Icons
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Icons']
slug: /tools/sdk/powershell/v2024/methods/icons
tags: ['SDK', 'Software Development Kit', 'Icons']
---
# Icons
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Remove-V2024Icon**](#delete-icon) | **DELETE** `/icons/{objectType}/{objectId}` | Delete an icon
[**Set-V2024Icon**](#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 | ObjectId | **String** | True | Object id.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### 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**: Not defined
- **Accept**: application/json
### Example
```powershell
$ObjectType = "application" # String | Object type. Available options ['application']
$ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete an icon
try {
Remove-V2024Icon-V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Icon"
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 | ObjectId | **String** | True | Object id.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
| Image | **System.IO.FileInfo** | True | file with icon. Allowed mime-types ['image/png', 'image/jpeg']
### Return type
[**SetIcon200Response**](../models/set-icon200-response)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Icon updated | SetIcon200Response
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**: multipart/form-data
- **Accept**: application/json
### Example
```powershell
$ObjectType = "application" # String | Object type. Available options ['application']
$ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg']
# Update an icon
try {
Set-V2024Icon-V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental -V2024Image $Image
# Below is a request that includes all optional parameters
# Set-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental -V2024Image $Image
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Icon"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)