developer.sailpoint.com/docs/tools/sdk/powershell/refrence/beta/Methods/BetaUIMetadataApi.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
ui-metadata	UIMetadata	UIMetadata	UIMetadata	powershellsdk	powershell PowerShell sdk UIMetadata	/tools/sdk/powershell/beta/methods/ui-metadata	SDK Software Development Kit UIMetadata

UIMetadata

All URIs are relative to https://sailpoint.api.identitynow.com/beta

Method	HTTP request	Description
Get-BetaTenantUiMetadata	GET /ui-metadata/tenant	Get a tenant UI metadata
Set-BetaTenantUiMetadata	PUT /ui-metadata/tenant	Update tenant UI metadata

get-tenant-ui-metadata

This API endpoint retrieves UI metadata configured for your tenant. A token with ORG_ADMIN authority is required to call this API.

Parameters

Param Type	Name	Data Type	Required	Description

Return type

TenantUiMetadataItemResponse

Responses

Code	Description	Data Type
200	A tenant UI metadata object	TenantUiMetadataItemResponse
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

# Get a tenant UI metadata
try {
    Get-BetaTenantUiMetadata
    
    # Below is a request that includes all optional parameters
    # Get-BetaTenantUiMetadata  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantUiMetadata"
    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. A token with ORG_ADMIN authority is required to call this API.

Parameters

Param Type	Name	Data Type	Required	Description
Body	TenantUiMetadataItemUpdateRequest	TenantUiMetadataItemUpdateRequest	True

Return type

TenantUiMetadataItemResponse

Responses

Code	Description	Data Type
200	A tenant UI metadata object	TenantUiMetadataItemResponse
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

$TenantUiMetadataItemUpdateRequest = @"{
  "usernameEmptyText" : "Please provide your work email address...",
  "usernameLabel" : "Email",
  "iframeWhiteList" : "http://example.com http://example2.com"
}"@
# Update tenant UI metadata
try {
    $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest
    Set-BetaTenantUiMetadata-BetaTenantUiMetadataItemUpdateRequest $Result
    
    # Below is a request that includes all optional parameters
    # Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $TenantUiMetadataItemUpdateRequest  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTenantUiMetadata"
    Write-Host $_.ErrorDetails
}

[Back to top]