Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OAuth2Options

Options describing how an OAuth2 will make connections.

Hierarchy

  • OAuth2Options

Index

Constructors

Methods

Constructors

constructor

  • Returns OAuth2Options

  • Parameters

    Returns OAuth2Options

Methods

addPubSecKey

  • The provider PubSec key options

    Parameters

    • pubSecKeys: PubSecKeyOptions

    Returns OAuth2Options

addSupportedGrantType

  • addSupportedGrantType(supportedGrantTypes: string): OAuth2Options

  • The provider supported grant types

    Parameters

    • supportedGrantTypes: string

    Returns OAuth2Options

getAuthorizationPath

  • getAuthorizationPath(): string

  • Get the Oauth2 authorization resource path. e.g.: /oauth/authorize

    Returns string

getClientAssertion

  • getClientAssertion(): string

  • Returns string

getClientAssertionType

  • getClientAssertionType(): string

  • Returns string

getClientID

  • getClientID(): string

  • Returns string

getClientId

  • getClientId(): string

  • Set the provider client id

    Returns string

getClientSecret

  • getClientSecret(): string

  • Set the provider client secret

    Returns string

getExtraParameters

  • getExtraParameters(): {}

  • Set extra parameters to be sent to the provider on each request

    Returns {}

    • [key: string]: any

getFlow

  • Returns OAuth2FlowType

getHeaders

  • getHeaders(): {}

  • Set custom headers to be sent with every request to the provider

    Returns {}

    • [key: string]: any

getHttpClientOptions

  • getHttpClientOptions(): HttpClientOptions

  • Returns HttpClientOptions

getIntrospectionPath

  • getIntrospectionPath(): string

  • Set the provider token introspection resource path

    Returns string

getJWTOptions

  • getJWTOptions(): JWTOptions

  • Returns JWTOptions

getJwkMaxAgeInSeconds

  • getJwkMaxAgeInSeconds(): number

  • -1 means no rotation for JWKs

    Returns number

getJwkPath

  • getJwkPath(): string

  • Returns string

getLogoutPath

  • getLogoutPath(): string

  • Set the provider logout path

    Returns string

getPubSecKeys

  • getPubSecKeys(): PubSecKeyOptions[]

  • The provider PubSec key options

    Returns PubSecKeyOptions[]

getRevocationPath

  • getRevocationPath(): string

  • Set the Oauth2 revocation resource path. e.g.: /oauth/revoke

    Returns string

getScopeSeparator

  • getScopeSeparator(): string

  • Set the provider scope separator

    Returns string

getSite

  • getSite(): string

  • Root URL for the provider without trailing slashes

    Returns string

getSupportedGrantTypes

  • getSupportedGrantTypes(): string[]

  • The provider supported grant types

    Returns string[]

getTenant

  • getTenant(): string

  • Sets an optional tenant. Tenants are used in some OpenID servers as placeholders for the URLs. The tenant should be set prior to any URL as it affects the way the URLs will be stored.

    Some provders may name this differently, for example: `realm`.

    Returns string

getTokenPath

  • getTokenPath(): string

  • Get the Oauth2 token resource path. e.g.: /oauth/token

    Returns string

getUserAgent

  • getUserAgent(): string

  • Set a custom user agent to use when communicating to a provider

    Returns string

getUserInfoParameters

  • getUserInfoParameters(): {}

  • Set custom parameters to be sent during the userInfo resource request

    Returns {}

    • [key: string]: any

getUserInfoPath

  • getUserInfoPath(): string

  • Set the provider userInfo resource path

    Returns string

isRotateJWKs

  • isRotateJWKs(): boolean

  • Enable/Disable the JWKs rotation.

    Returns boolean

isValidateIssuer

  • isValidateIssuer(): boolean

  • Returns boolean

setAuthorizationPath

  • Get the Oauth2 authorization resource path. e.g.: /oauth/authorize

    Parameters

    • authorizationPath: string

    Returns OAuth2Options

setClientAssertion

  • Parameters

    • clientAssertion: string

    Returns OAuth2Options

setClientAssertionType

  • setClientAssertionType(clientAssertionType: string): OAuth2Options

  • Parameters

    • clientAssertionType: string

    Returns OAuth2Options

setClientID

  • Parameters

    • clientID: string

    Returns OAuth2Options

setClientId

  • Set the provider client id

    Parameters

    • clientId: string

    Returns OAuth2Options

setClientSecret

  • Set the provider client secret

    Parameters

    • clientSecret: string

    Returns OAuth2Options

setExtraParameters

  • Set extra parameters to be sent to the provider on each request

    Parameters

    • extraParameters: {}
      • [key: string]: any

    Returns OAuth2Options

setFlow

setHeaders

  • Set custom headers to be sent with every request to the provider

    Parameters

    • headers: {}
      • [key: string]: any

    Returns OAuth2Options

setHttpClientOptions

  • setHttpClientOptions(httpClientOptions: HttpClientOptions): OAuth2Options

  • Parameters

    • httpClientOptions: HttpClientOptions

    Returns OAuth2Options

setIntrospectionPath

  • Set the provider token introspection resource path

    Parameters

    • introspectionPath: string

    Returns OAuth2Options

setJWTOptions

  • Parameters

    • jwtOptions: JWTOptions

    Returns OAuth2Options

setJwkMaxAgeInSeconds

  • setJwkMaxAgeInSeconds(jwkMaxAgeInSeconds: number): OAuth2Options

  • -1 means no rotation for JWKs

    Parameters

    • jwkMaxAgeInSeconds: number

    Returns OAuth2Options

setJwkPath

  • Parameters

    • jwkPath: string

    Returns OAuth2Options

setLogoutPath

  • Set the provider logout path

    Parameters

    • logoutPath: string

    Returns OAuth2Options

setPubSecKeys

  • The provider PubSec key options

    Parameters

    • pubSecKeys: PubSecKeyOptions[]

    Returns OAuth2Options

setRevocationPath

  • Set the Oauth2 revocation resource path. e.g.: /oauth/revoke

    Parameters

    • revocationPath: string

    Returns OAuth2Options

setRotateJWKs

  • Enable/Disable the JWKs rotation.

    Parameters

    • rotateJWKs: boolean

    Returns OAuth2Options

setScopeSeparator

  • Set the provider scope separator

    Parameters

    • scopeSeparator: string

    Returns OAuth2Options

setSite

  • Root URL for the provider without trailing slashes

    Parameters

    • site: string

    Returns OAuth2Options

setSupportedGrantTypes

  • setSupportedGrantTypes(supportedGrantTypes: string[]): OAuth2Options

  • The provider supported grant types

    Parameters

    • supportedGrantTypes: string[]

    Returns OAuth2Options

setTenant

  • Sets an optional tenant. Tenants are used in some OpenID servers as placeholders for the URLs. The tenant should be set prior to any URL as it affects the way the URLs will be stored.

    Some provders may name this differently, for example: `realm`.

    Parameters

    • tenant: string

    Returns OAuth2Options

setTokenPath

  • Get the Oauth2 token resource path. e.g.: /oauth/token

    Parameters

    • tokenPath: string

    Returns OAuth2Options

setUserAgent

  • Set a custom user agent to use when communicating to a provider

    Parameters

    • userAgent: string

    Returns OAuth2Options

setUserInfoParameters

  • Set custom parameters to be sent during the userInfo resource request

    Parameters

    • userInfoParameters: {}
      • [key: string]: any

    Returns OAuth2Options

setUserInfoPath

  • Set the provider userInfo resource path

    Parameters

    • userInfoPath: string

    Returns OAuth2Options

setValidateIssuer

  • Parameters

    • validateIssuer: boolean

    Returns OAuth2Options

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc