Skip to main content

TenantUiMetadataItemResponse

Properties

NameTypeDescriptionNotes
IframeWhiteListStringParameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use ""null"". It will only allow include into iframe non authenticated portions of the product, such as password reset.[optional]
UsernameLabelStringDescriptor for the username input field. If you would like to reset the value use ""null"".[optional]
UsernameEmptyTextStringPlaceholder text displayed in the username input field. If you would like to reset the value use ""null"".[optional]
InstanceBadgeDisplayNameStringDisplay name for the instance badge. Null when no display name is configured.[optional]
InstanceBadgeColorStringHex value of color for the instance badge. Null when no color is configured.[optional]
InstanceBadgeVisibleBooleanWhether the instance badge is visible. Defaults to false when no value is stored.[optional] [default to $false]

Examples

  • Prepare the resource
$TenantUiMetadataItemResponse = Initialize-TenantUiMetadataItemResponse -IframeWhiteList http://example.com http://example2.com `
-UsernameLabel Email `
-UsernameEmptyText Please provide your work email address... `
-InstanceBadgeDisplayName Sandbox `
-InstanceBadgeColor FFAA00 `
-InstanceBadgeVisible true
  • Convert the resource to JSON
$TenantUiMetadataItemResponse | ConvertTo-JSON

[Back to top]