mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 04:19:42 +00:00
add method and model docs for powershell and python v2025
This commit is contained in:
darrell-thobe-sp
174
docs/tools/sdk/python/Reference/V2025/Methods/IconsApi.md
Normal file
174
docs/tools/sdk/python/Reference/V2025/Methods/IconsApi.md
Normal file
@@ -0,0 +1,174 @@
|
||||
---
|
||||
id: v2025-icons
|
||||
title: Icons
|
||||
pagination_label: Icons
|
||||
sidebar_label: Icons
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Icons', 'V2025Icons']
|
||||
slug: /tools/sdk/python/v2025/methods/icons
|
||||
tags: ['SDK', 'Software Development Kit', 'Icons', 'V2025Icons']
|
||||
---
|
||||
|
||||
# sailpoint.v2025.IconsApi
|
||||
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.
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**delete-icon**](#delete-icon) | **DELETE** `/icons/{objectType}/{objectId}` | Delete an icon
|
||||
[**set-icon**](#set-icon) | **PUT** `/icons/{objectType}/{objectId}` | Update an icon
|
||||
|
||||
|
||||
## delete-icon
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Delete an 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/v2025/delete-icon)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | object_type | **str** | True | Object type. Available options ['application']
|
||||
Path | object_id | **str** | True | Object id.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
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
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.api.icons_api import IconsApi
|
||||
from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application']
|
||||
object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Delete an icon
|
||||
|
||||
IconsApi(api_client).delete_icon(object_type=object_type, object_id=object_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# IconsApi(api_client).delete_icon(object_type, object_id, x_sail_point_experimental)
|
||||
except Exception as e:
|
||||
print("Exception when calling IconsApi->delete_icon: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## set-icon
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
:::tip setting x-sailpoint-experimental header
|
||||
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
|
||||
Example:
|
||||
```python
|
||||
configuration = Configuration()
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Update an 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/v2025/set-icon)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | object_type | **str** | True | Object type. Available options ['application']
|
||||
Path | object_id | **str** | True | Object id.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
| image | **bytearray** | True | file with icon. Allowed mime-types ['image/png', 'image/jpeg']
|
||||
|
||||
### Return type
|
||||
[**SetIcon200Response**](../models/set-icon200-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
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
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.api.icons_api import IconsApi
|
||||
from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.v2025.models.set_icon200_response import SetIcon200Response
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
configuration.experimental = true
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application']
|
||||
object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
image = None # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg']
|
||||
|
||||
try:
|
||||
# Update an icon
|
||||
|
||||
results = IconsApi(api_client).set_icon(object_type=object_type, object_id=object_id, x_sail_point_experimental=x_sail_point_experimental, image=image)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IconsApi(api_client).set_icon(object_type, object_id, x_sail_point_experimental, image)
|
||||
print("The response of IconsApi->set_icon:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling IconsApi->set_icon: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user