Type Alias AuthSettingsResource

The authentication settings for a tenant, controlling user session duration and inactivity behavior.

type AuthSettingsResource = {
    dcrAllowedAuthenticationMethods?: ("none" | "client_secret")[];
    dynamicClientRegistrationEnabled?: boolean;
    id?: string;
    isDefault?: boolean;
    maxUserSessionLifespanMinutes: number;
    tenantId: string;
    userSessionInactivityTimeoutMinutes: number;
}

Properties

dcrAllowedAuthenticationMethods?: ("none" | "client_secret")[]

The allowed authentication methods for dynamic client registration. Only present when dynamic client registration is enabled.

dynamicClientRegistrationEnabled?: boolean

Indicates whether dynamic client registration is enabled for this tenant.

id?: string

The unique identifier for the authentication settings.

isDefault?: boolean

true if the authentication settings are using tenant-wide defaults. No custom values have been saved for this tenant.

maxUserSessionLifespanMinutes: number

Maximum total lifespan for a user session, in minutes. Sessions are invalidated after this duration regardless of activity.

tenantId: string

The tenant unique identifier associated with the authentication settings.

userSessionInactivityTimeoutMinutes: number

Maximum inactivity period for a user session, in minutes. Sessions that have been idle for longer than this value are invalidated.