LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 20:37: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

18
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024UIMetadataApi.md
View File

@@ -1,3 +1,4 @@
---
id: v2024-ui-metadata
title: UIMetadata
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v2024/methods/ui-metadata
tags: ['SDK', 'Software Development Kit', 'UIMetadata', 'V2024UIMetadata']
---
# UIMetadata
API for managing UI Metadata. Use this API to manage metadata about your User Interface.
For example you can set the iFrameWhitelist parameter to permit another domain to encapsulate IDN within an iframe or set the usernameEmptyText to change the placeholder text for Username on your tenant's login screen.
@@ -22,9 +22,7 @@ Method | HTTP request | Description
[**Get-V2024TenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata
[**Set-V2024TenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata
## get-tenant-ui-metadata
This API endpoint retrieves UI metadata configured for your tenant.
### Parameters
@@ -33,7 +31,6 @@ Param Type | Name | Data Type | Required | Description
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response)
### Responses
@@ -48,14 +45,15 @@ 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
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get a tenant UI metadata
try {
Get-V2024TenantUiMetadata-V2024XSailPointExperimental $XSailPointExperimental
@@ -66,11 +64,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-tenant-ui-metadata
This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI.
### Parameters
@@ -80,7 +75,6 @@ Param Type | Name | Data Type | Required | Description
Body | TenantUiMetadataItemUpdateRequest | [**TenantUiMetadataItemUpdateRequest**](../models/tenant-ui-metadata-item-update-request) | True |
### Return type
[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response)
### Responses
@@ -95,7 +89,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -107,7 +100,9 @@ $TenantUiMetadataItemUpdateRequest = @"{
"usernameLabel" : "Email",
"iframeWhiteList" : "http://example.com http://example2.com"
}"@
# Update tenant UI metadata
try {
$Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest
Set-V2024TenantUiMetadata-V2024XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result
@@ -119,7 +114,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)