UIMetadataApi
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. All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| get-tenant-ui-metadata-v1 | GET /ui-metadata/v1/tenant | Get a tenant ui metadata |
| set-tenant-ui-metadata-v1 | PUT /ui-metadata/v1/tenant | Update tenant ui metadata |
get-tenant-ui-metadata-v1
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.
Get a tenant ui metadata This API endpoint retrieves UI metadata configured for your tenant.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Tenantuimetadataitemresponse
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { UIMetadataApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new UIMetadataApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getTenantUiMetadataV1({ });
console.log(result);
set-tenant-ui-metadata-v1
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.
Update 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
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantuimetadataitemupdaterequest | Tenantuimetadataitemupdaterequest | ||
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Tenantuimetadataitemresponse
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { UIMetadataApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new UIMetadataApi(configuration);
const tenantuimetadataitemupdaterequest: Tenantuimetadataitemupdaterequest = ; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.setTenantUiMetadataV1({ tenantuimetadataitemupdaterequest: tenantuimetadataitemupdaterequest });
console.log(result);