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/v2024
:::warning 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.
:::
:::tip 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:
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.
ListAccessProfiles401Response
-
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.
ListAccessProfiles429Response
-
500
Internal Server Error - Returned if there is an unexpected error.
ErrorResponseDto
-
HTTP request headers
Content-Type: Not defined
Accept: application/json
Example
fromsailpoint.v2024.api.ui_metadata_apiimportUIMetadataApifromsailpoint.v2024.api_clientimportApiClientfromsailpoint.v2024.models.tenant_ui_metadata_item_responseimportTenantUiMetadataItemResponsefromsailpoint.configurationimportConfigurationconfiguration=Configuration()configuration.experimental=TruewithApiClient(configuration)asapi_client:x_sail_point_experimental='true'# str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')try:# Get a tenant ui metadataresults=UIMetadataApi(api_client).get_tenant_ui_metadata(x_sail_point_experimental=x_sail_point_experimental)# Below is a request that includes all optional parameters# results = UIMetadataApi(api_client).get_tenant_ui_metadata(x_sail_point_experimental)print("The response of UIMetadataApi->get_tenant_ui_metadata:\n")print(results.model_dump_json(by_alias=True,indent=4))exceptExceptionase:print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n"%e)
:::warning 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.
:::
:::tip 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:
:::
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.
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.
ListAccessProfiles401Response
-
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.
ListAccessProfiles429Response
-
500
Internal Server Error - Returned if there is an unexpected error.
ErrorResponseDto
-
HTTP request headers
Content-Type: application/json
Accept: application/json
Example
fromsailpoint.v2024.api.ui_metadata_apiimportUIMetadataApifromsailpoint.v2024.api_clientimportApiClientfromsailpoint.v2024.models.tenant_ui_metadata_item_responseimportTenantUiMetadataItemResponsefromsailpoint.v2024.models.tenant_ui_metadata_item_update_requestimportTenantUiMetadataItemUpdateRequestfromsailpoint.configurationimportConfigurationconfiguration=Configuration()configuration.experimental=TruewithApiClient(configuration)asapi_client:x_sail_point_experimental='true'# str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')tenant_ui_metadata_item_update_request='''{
"usernameEmptyText" : "Please provide your work email address...",
"usernameLabel" : "Email",
"iframeWhiteList" : "http://example.com http://example2.com"
}'''# TenantUiMetadataItemUpdateRequest | try:# Update tenant ui metadatanew_tenant_ui_metadata_item_update_request=TenantUiMetadataItemUpdateRequest.from_json(tenant_ui_metadata_item_update_request)results=UIMetadataApi(api_client).set_tenant_ui_metadata(x_sail_point_experimental=x_sail_point_experimental,tenant_ui_metadata_item_update_request=new_tenant_ui_metadata_item_update_request)# Below is a request that includes all optional parameters# results = UIMetadataApi(api_client).set_tenant_ui_metadata(x_sail_point_experimental, new_tenant_ui_metadata_item_update_request)print("The response of UIMetadataApi->set_tenant_ui_metadata:\n")print(results.model_dump_json(by_alias=True,indent=4))exceptExceptionase:print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n"%e)
