Type Alias AuthSettingsAPI

type AuthSettingsAPI = {
    clearCache: typeof authSettings.clearCache;
    getAuthSettings: typeof getAuthSettings;
    patchAuthSettings: typeof patchAuthSettings;
}
Index

Properties

clearCache: typeof authSettings.clearCache

Clears the cache for auth-settings api requests.

getAuthSettings: typeof getAuthSettings

Returns the authentication settings for the tenant, including the session inactivity timeout and maximum session lifespan. If no custom values have been saved, the response reflects tenant-wide defaults with isDefault set to true. The user must be assigned the TenantAdmin role.

GetAuthSettingsHttpError

patchAuthSettings: typeof patchAuthSettings

Updates one or more authentication settings for the tenant using JSON Patch (RFC 6902). Supports replace operations on /userSessionInactivityTimeoutMinutes and /maxUserSessionLifespanMinutes. The value for maxUserSessionLifespanMinutes must be a whole number of hours (divisible by 60). The user must be assigned the TenantAdmin role.

an object with the body content

PatchAuthSettingsHttpError