Type Alias UiConfigAPI

type UiConfigAPI = {
    clearCache: typeof clearCache;
    createUiConfigPinnedLink: typeof createUiConfigPinnedLink;
    createUiConfigPinnedLinks: typeof createUiConfigPinnedLinks;
    deleteAllUiConfigPinnedLinks: typeof deleteAllUiConfigPinnedLinks;
    deleteUiConfigPinnedLink: typeof deleteUiConfigPinnedLink;
    getUiConfigPinnedLink: typeof getUiConfigPinnedLink;
    getUiConfigPinnedLinks: typeof getUiConfigPinnedLinks;
    patchUiConfigPinnedLink: typeof patchUiConfigPinnedLink;
}
Index

Properties

clearCache createUiConfigPinnedLink createUiConfigPinnedLinks deleteAllUiConfigPinnedLinks deleteUiConfigPinnedLink getUiConfigPinnedLink getUiConfigPinnedLinks patchUiConfigPinnedLink

Properties

clearCache: typeof clearCache

Clears the cache for ui-config api requests.

createUiConfigPinnedLink: typeof createUiConfigPinnedLink

Creates a pinned link, which will appear below any existing pinned links in the tenant. Requires calling user to be assigned the TenantAdmin role. A tenant can have a maximum of 50 pinned links.

Param: body

an object with the body content

CreateUiConfigPinnedLinkHttpError

createUiConfigPinnedLinks: typeof createUiConfigPinnedLinks

Creates one or more pinned links for navigation, an alternative method to multiple calls to /ui-config/pinned-links. Links are displayed below any existing pinned links, and will be added in the order sent in the request. Requires calling user to be assigned the TenantAdmin role. A tenant can have a maximum of 50 pinned links.

Param: body

an object with the body content

CreateUiConfigPinnedLinksHttpError

deleteAllUiConfigPinnedLinks: typeof deleteAllUiConfigPinnedLinks

Deletes all pinned links in the tenant. Requires calling user to be assigned the TenantAdmin role.

DeleteAllUiConfigPinnedLinksHttpError

deleteUiConfigPinnedLink: typeof deleteUiConfigPinnedLink

Deletes a specific pinned link. Requires calling user to be assigned the TenantAdmin role.

The pinned link identifier.

DeleteUiConfigPinnedLinkHttpError

getUiConfigPinnedLink: typeof getUiConfigPinnedLink

Retrieves a specific pinned link.

The pinned link identifier.

GetUiConfigPinnedLinkHttpError

getUiConfigPinnedLinks: typeof getUiConfigPinnedLinks

Retrieves a list of all pinned links. All users can list pinned links. This endpoint does not support pagination as a tenant can have a maximum of 50 pinned links at one time.

GetUiConfigPinnedLinksHttpError

patchUiConfigPinnedLink: typeof patchUiConfigPinnedLink

Updates a specific pinned link with an array of JSON patches. Requires calling user to be assigned the TenantAdmin role.

The pinned link identifier.

Param: body

an object with the body content

PatchUiConfigPinnedLinkHttpError

Settings

Member Visibility

On This Page

Properties