Skip to main content

Interface: IdpSettings

Hierarchy​

Properties​

authorizeEndpoint​

• Optional authorizeEndpoint: string | (params: AnonymousObject<any>, idp: Idp, context: AppContext) => string | Promise<string>

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:58


callback​

• Optional callback: "token" | "securityContext" | (response: any, idp: Idp, context: AppContext) => [any?, AnonymousObject<any>?]

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:59


clientAuth​

• Optional clientAuth: IdpClientAuth

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:60


clientId​

• Optional clientId: string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:61


clientSecret​

• Optional clientSecret: string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:62


clockSkew​

• Optional clockSkew: number

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:63


codeChallengeMethod​

• Optional codeChallengeMethod: S256

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:64


cookieCrypt​

• Optional cookieCrypt: boolean

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:65


cookiePath​

• Optional cookiePath: string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:66


cookieSecure​

• Optional cookieSecure: boolean

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:67


cookieTTL​

• Optional cookieTTL: number

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:68


external​

• Optional external: boolean

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:69


externalLoginEndpoint​

• Optional externalLoginEndpoint: string | (idp: Idp, context: AppContext) => string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:70


externalLogoutEndpoint​

• Optional externalLogoutEndpoint: string | (idp: Idp, context: AppContext) => string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:71


jwksEndpoint​

• Optional jwksEndpoint: string | (token: any, idp: Idp, context: AppContext) => string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:72


loginCallbackRoute​

• Optional loginCallbackRoute: string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:73


loginContentType​

• Optional loginContentType: IdpContentType

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:74


loginEndpoint​

• Optional loginEndpoint: string | (data: AnonymousObject<any>, idp: Idp, context: AppContext) => unknown

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:75


loginMethod​

• Optional loginMethod: IdpMethod

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:76


logoutCallbackRoute​

• Optional logoutCallbackRoute: string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:78


logoutEndpoint​

• Optional logoutEndpoint: string | (idp: Idp, context: AppContext) => string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:79


logoutMethod​

• Optional logoutMethod: IdpMethod

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:77


name​

• Optional name: string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:80


nonce​

• Optional nonce: boolean

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:81


oauth2​

• Optional oauth2: boolean

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:82


oidc​

• Optional oidc: boolean

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:83


passwordKey​

• Optional passwordKey: string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:84


persist​

• Optional persist: "localStorage" | "sessionStorage" | "cookie" | "memory"

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:87


pkce​

• Optional pkce: boolean

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:88


postLoginRedirectKey​

• Optional postLoginRedirectKey: string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:89


postLogoutRedirectKey​

• Optional postLogoutRedirectKey: string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:90


pubKeyAlgorithm​

• Optional pubKeyAlgorithm: RS256

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:91


rememberMeKey​

• Optional rememberMeKey: string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:85


responseType​

• Optional responseType: Code

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:92


scope​

• Optional scope: string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:93


state​

• Optional state: boolean

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:94


tokenEndpoint​

• Optional tokenEndpoint: string | (grant_type: string, idp: Idp, context: AppContext) => string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:96


type​

• Optional type: "form" | "oidc_browser" | "oidc_server" | "external" | "oauth2_browser" | "oauth2_server"

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:95


userinfoEndpoint​

• Optional userinfoEndpoint: string | (idp: Idp, context: AppContext) => string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:97


usernameKey​

• Optional usernameKey: string

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:86


validate​

• Optional validate: boolean

Defined in​

onekijs/packages/onekijs-framework/src/auth/typings.ts:98