Skip to main content

Interface: Idp

Hierarchy​

Properties​

authorizeEndpoint​

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

Inherited from​

IdpSettings.authorizeEndpoint

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>?]

Inherited from​

IdpSettings.callback

Defined in​

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


clientAuth​

• Optional clientAuth: IdpClientAuth

Inherited from​

IdpSettings.clientAuth

Defined in​

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


clientId​

• Optional clientId: string

Inherited from​

IdpSettings.clientId

Defined in​

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


clientSecret​

• Optional clientSecret: string

Inherited from​

IdpSettings.clientSecret

Defined in​

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


clockSkew​

• Optional clockSkew: number

Inherited from​

IdpSettings.clockSkew

Defined in​

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


codeChallengeMethod​

• Optional codeChallengeMethod: S256

Inherited from​

IdpSettings.codeChallengeMethod

Defined in​

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


cookieCrypt​

• Optional cookieCrypt: boolean

Inherited from​

IdpSettings.cookieCrypt

Defined in​

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


cookiePath​

• Optional cookiePath: string

Inherited from​

IdpSettings.cookiePath

Defined in​

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


cookieSecure​

• Optional cookieSecure: boolean

Inherited from​

IdpSettings.cookieSecure

Defined in​

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


cookieTTL​

• Optional cookieTTL: number

Inherited from​

IdpSettings.cookieTTL

Defined in​

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


external​

• external: boolean

Overrides​

IdpSettings.external

Defined in​

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


externalLoginEndpoint​

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

Inherited from​

IdpSettings.externalLoginEndpoint

Defined in​

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


externalLogoutEndpoint​

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

Inherited from​

IdpSettings.externalLogoutEndpoint

Defined in​

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


jwksEndpoint​

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

Inherited from​

IdpSettings.jwksEndpoint

Defined in​

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


loginCallbackRoute​

• Optional loginCallbackRoute: string

Inherited from​

IdpSettings.loginCallbackRoute

Defined in​

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


loginContentType​

• Optional loginContentType: IdpContentType

Inherited from​

IdpSettings.loginContentType

Defined in​

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


loginEndpoint​

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

Inherited from​

IdpSettings.loginEndpoint

Defined in​

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


loginMethod​

• Optional loginMethod: IdpMethod

Inherited from​

IdpSettings.loginMethod

Defined in​

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


logoutCallbackRoute​

• Optional logoutCallbackRoute: string

Inherited from​

IdpSettings.logoutCallbackRoute

Defined in​

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


logoutEndpoint​

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

Inherited from​

IdpSettings.logoutEndpoint

Defined in​

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


logoutMethod​

• Optional logoutMethod: IdpMethod

Inherited from​

IdpSettings.logoutMethod

Defined in​

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


name​

• name: string

Overrides​

IdpSettings.name

Defined in​

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


nonce​

• Optional nonce: boolean

Inherited from​

IdpSettings.nonce

Defined in​

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


oauth2​

• oauth2: boolean

Overrides​

IdpSettings.oauth2

Defined in​

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


oidc​

• oidc: boolean

Overrides​

IdpSettings.oidc

Defined in​

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


passwordKey​

• Optional passwordKey: string

Inherited from​

IdpSettings.passwordKey

Defined in​

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


persist​

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

Inherited from​

IdpSettings.persist

Defined in​

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


pkce​

• Optional pkce: boolean

Inherited from​

IdpSettings.pkce

Defined in​

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


postLoginRedirectKey​

• Optional postLoginRedirectKey: string

Inherited from​

IdpSettings.postLoginRedirectKey

Defined in​

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


postLogoutRedirectKey​

• Optional postLogoutRedirectKey: string

Inherited from​

IdpSettings.postLogoutRedirectKey

Defined in​

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


pubKeyAlgorithm​

• Optional pubKeyAlgorithm: RS256

Inherited from​

IdpSettings.pubKeyAlgorithm

Defined in​

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


rememberMeKey​

• Optional rememberMeKey: string

Inherited from​

IdpSettings.rememberMeKey

Defined in​

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


responseType​

• Optional responseType: Code

Inherited from​

IdpSettings.responseType

Defined in​

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


scope​

• Optional scope: string

Inherited from​

IdpSettings.scope

Defined in​

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


state​

• Optional state: boolean

Inherited from​

IdpSettings.state

Defined in​

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


tokenEndpoint​

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

Overrides​

IdpSettings.tokenEndpoint

Defined in​

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


type​

• type: IdpType

Overrides​

IdpSettings.type

Defined in​

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


userinfoEndpoint​

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

Overrides​

IdpSettings.userinfoEndpoint

Defined in​

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


usernameKey​

• Optional usernameKey: string

Inherited from​

IdpSettings.usernameKey

Defined in​

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


validate​

• Optional validate: boolean

Overrides​

IdpSettings.validate

Defined in​

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