sailpoint.ui_metadata.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
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.
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:
configuration = Configuration()
configuration.experimental = True
Get a tenant ui metadata This API endpoint retrieves UI metadata configured for your tenant.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| x_sail_point_experimental | str | (optional) (default to 'true') | Use this header to enable this experimental API. |
Return type
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 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. | GetTenantUiMetadataV1401Response | - |
| 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. | GetTenantUiMetadataV1429Response | - |
| 500 | Internal Server Error - Returned if there is an unexpected error. | Errorresponsedto | - |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.ui_metadata.api.ui_metadata_api import UIMetadataApi
from sailpoint.ui_metadata.api_client import ApiClient
from sailpoint.ui_metadata.models.tenantuimetadataitemresponse import Tenantuimetadataitemresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')
try:
# Get a tenant ui metadata
results = UIMetadataApi(api_client).get_tenant_ui_metadata_v1()
# Below is a request that includes all optional parameters
# results = UIMetadataApi(api_client).get_tenant_ui_metadata_v1(x_sail_point_experimental)
print("The response of UIMetadataApi->get_tenant_ui_metadata_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling UIMetadataApi->get_tenant_ui_metadata_v1: %s\n" % e)
set-tenant-ui-metadata-v1
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.
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:
configuration = Configuration()
configuration.experimental = True
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
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Body | tenantuimetadataitemupdaterequest | Tenantuimetadataitemupdaterequest | True | |
| x_sail_point_experimental | str | (optional) (default to 'true') | Use this header to enable this experimental API. |
Return type
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 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. | GetTenantUiMetadataV1401Response | - |
| 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. | GetTenantUiMetadataV1429Response | - |
| 500 | Internal Server Error - Returned if there is an unexpected error. | Errorresponsedto | - |
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.ui_metadata.api.ui_metadata_api import UIMetadataApi
from sailpoint.ui_metadata.api_client import ApiClient
from sailpoint.ui_metadata.models.tenantuimetadataitemresponse import Tenantuimetadataitemresponse
from sailpoint.ui_metadata.models.tenantuimetadataitemupdaterequest import Tenantuimetadataitemupdaterequest
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
tenantuimetadataitemupdaterequest = '''sailpoint.ui_metadata.Tenantuimetadataitemupdaterequest()''' # Tenantuimetadataitemupdaterequest |
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (optional) (default to 'true') # str | Use this header to enable this experimental API. (optional) (default to 'true')
try:
# Update tenant ui metadata
new_tenantuimetadataitemupdaterequest = Tenantuimetadataitemupdaterequest.from_json(tenantuimetadataitemupdaterequest)
results = UIMetadataApi(api_client).set_tenant_ui_metadata_v1(tenantuimetadataitemupdaterequest=new_tenantuimetadataitemupdaterequest)
# Below is a request that includes all optional parameters
# results = UIMetadataApi(api_client).set_tenant_ui_metadata_v1(new_tenantuimetadataitemupdaterequest, x_sail_point_experimental)
print("The response of UIMetadataApi->set_tenant_ui_metadata_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling UIMetadataApi->set_tenant_ui_metadata_v1: %s\n" % e)