Class OAuth2Util

[[include:auth/oAuth2Util.md]]

Hierarchy

  • FullAuthUtil
    • OAuth2Util

Constructors

constructor

Properties

accessTokenUrl? authUrl? challengeAlgorithm? clientAuthentication? clientId? clientSecret? codeVerifier? description? grantType? headerPrefix? host? password? redirectUri? refreshUrl? scopes securitySchemeName state? tokenLocation? tokenName? useBrowser? username?

Methods

addScope clientAuthenticationToBody clientAuthenticationToHeader getAccessTokenUrl getAuthUrl getChallengeAlgorithm getClientAuthentication getClientId getClientSecret getCodeVerifier getDescription getGrantType getHeaderPrefix getHost getPassword getRedirectUri getRefreshUrl getScopes getScopesNames getSecuritySchemeName getState getTokenLocation getTokenName getUseBrowser getUsername removeAccessTokenUrl removeAuthUrl removeChallengeAlgorithm removeClientAuthentication removeClientId removeClientSecret removeCodeVerifier removeDescription removeGrantType removeHeaderPrefix removeHost removePassword removeRedirectUri removeRefreshUrl removeScopes removeState removeTokenLocation removeTokenName removeUseBrowser removeUsername setAccessTokenUrl setAuthUrl setChallengeAlgorithm setClientAuthentication setClientId setClientSecret setCodeVerifier setDescription setGrantType setHeaderPrefix setHost setPassword setRedirectUri setRefreshUrl setScopes setState setTokenLocation setTokenName setUseBrowser setUsername toOpenAPI toOpenAPISecurity toPostman

Constructors

constructor

  • new OAuth2Util(securitySchemeName): OAuth2Util

  • Parameters

    • securitySchemeName: string

    Returns OAuth2Util

Properties

Protected OptionalaccessTokenUrl

accessTokenUrl?: string

Protected OptionalauthUrl

authUrl?: string

Protected OptionalchallengeAlgorithm

challengeAlgorithm?: string

Protected OptionalclientAuthentication

clientAuthentication?: string

Protected OptionalclientId

clientId?: string

Protected OptionalclientSecret

clientSecret?: string

Protected OptionalcodeVerifier

codeVerifier?: string

Protected Optionaldescription

description?: string

Protected OptionalgrantType

grantType?: string

Protected OptionalheaderPrefix

headerPrefix?: string

Protected Optionalhost

host?: string

Very optional. If set, it will be used for postman, concatenating accessTokenUrl and authUrl.

Protected Optionalpassword

password?: string

Protected OptionalredirectUri

redirectUri?: string

Protected OptionalrefreshUrl

refreshUrl?: string

Protectedscopes

scopes: Record<string, string>

ProtectedsecuritySchemeName

securitySchemeName: string

Protected Optionalstate

state?: string

Protected OptionaltokenLocation

tokenLocation?: string

Protected OptionaltokenName

tokenName?: string

Protected OptionaluseBrowser

useBrowser?: boolean

Protected Optionalusername

username?: string

Methods

addScope

  • addScope(scope, description?): OAuth2Util

  • Parameters

    • scope: string
    • Optionaldescription: string

    Returns OAuth2Util

clientAuthenticationToBody

  • clientAuthenticationToBody(): OAuth2Util

  • Send client credentials to body

    Returns OAuth2Util

clientAuthenticationToHeader

  • clientAuthenticationToHeader(): OAuth2Util

  • Send as Basic Auth header

    Returns OAuth2Util

getAccessTokenUrl

  • getAccessTokenUrl(): undefined | string

  • Returns undefined | string

getAuthUrl

  • getAuthUrl(): undefined | string

  • Returns undefined | string

getChallengeAlgorithm

  • getChallengeAlgorithm(): undefined | string

  • Returns undefined | string

getClientAuthentication

  • getClientAuthentication(): undefined | string

  • Returns undefined | string

getClientId

  • getClientId(): undefined | string

  • Returns undefined | string

getClientSecret

  • getClientSecret(): undefined | string

  • Returns undefined | string

getCodeVerifier

  • getCodeVerifier(): undefined | string

  • Returns undefined | string

getDescription

  • getDescription(): undefined | string

  • Returns undefined | string

getGrantType

  • getGrantType(): undefined | string

  • Returns undefined | string

getHeaderPrefix

  • getHeaderPrefix(): undefined | string

  • Returns undefined | string

getHost

  • getHost(): undefined | string

  • Returns undefined | string

getPassword

  • getPassword(): undefined | string

  • Returns undefined | string

getRedirectUri

  • getRedirectUri(): undefined | string

  • Returns undefined | string

getRefreshUrl

  • getRefreshUrl(): undefined | string

  • Returns undefined | string

getScopes

  • getScopes(): Record<string, string>

  • Returns Record<string, string>

getScopesNames

  • getScopesNames(): string[]

  • Returns string[]

getSecuritySchemeName

  • getSecuritySchemeName(): string

  • Returns string

getState

  • getState(): undefined | string

  • Returns undefined | string

getTokenLocation

  • getTokenLocation(): undefined | string

  • Returns undefined | string

getTokenName

  • getTokenName(): undefined | string

  • Returns undefined | string

getUseBrowser

  • getUseBrowser(): undefined | boolean

  • Returns undefined | boolean

getUsername

  • getUsername(): undefined | string

  • Returns undefined | string

removeAccessTokenUrl

  • removeAccessTokenUrl(): undefined | string

  • Returns undefined | string

removeAuthUrl

  • removeAuthUrl(): undefined | string

  • Returns undefined | string

removeChallengeAlgorithm

  • removeChallengeAlgorithm(): undefined | string

  • Returns undefined | string

removeClientAuthentication

  • removeClientAuthentication(): undefined | string

  • Returns undefined | string

removeClientId

  • removeClientId(): undefined | string

  • Returns undefined | string

removeClientSecret

  • removeClientSecret(): undefined | string

  • Returns undefined | string

removeCodeVerifier

  • removeCodeVerifier(): undefined | string

  • Returns undefined | string

removeDescription

  • removeDescription(): undefined | string

  • Returns undefined | string

removeGrantType

  • removeGrantType(): undefined | string

  • Returns undefined | string

removeHeaderPrefix

  • removeHeaderPrefix(): undefined | string

  • Returns undefined | string

removeHost

  • removeHost(): undefined | string

  • Returns undefined | string

removePassword

  • removePassword(): undefined | string

  • Returns undefined | string

removeRedirectUri

  • removeRedirectUri(): undefined | string

  • Returns undefined | string

removeRefreshUrl

  • removeRefreshUrl(): undefined | string

  • Returns undefined | string

removeScopes

  • removeScopes(): Record<string, string>

  • Returns Record<string, string>

removeState

  • removeState(): undefined | string

  • Returns undefined | string

removeTokenLocation

  • removeTokenLocation(): undefined | string

  • Returns undefined | string

removeTokenName

  • removeTokenName(): undefined | string

  • Returns undefined | string

removeUseBrowser

  • removeUseBrowser(): undefined | boolean

  • Returns undefined | boolean

removeUsername

  • removeUsername(): undefined | string

  • Returns undefined | string

setAccessTokenUrl

  • setAccessTokenUrl(accessTokenUrl): OAuth2Util

  • Parameters

    • accessTokenUrl: string

      The endpoint for authentication server. This is used to exchange the authorization code for an access token.

    Returns OAuth2Util

setAuthUrl

  • setAuthUrl(authUrl): OAuth2Util

  • Parameters

    • authUrl: string

      The endpoint for the authorization server. This is used to get the authorization code.

    Returns OAuth2Util

setChallengeAlgorithm

  • setChallengeAlgorithm(challengeAlgorithm): OAuth2Util

  • Parameters

    Returns OAuth2Util

  • setChallengeAlgorithm(challengeAlgorithm): OAuth2Util

  • Parameters

    • challengeAlgorithm: string

    Returns OAuth2Util

setClientAuthentication

  • setClientAuthentication(clientAuthentication): OAuth2Util

  • Parameters

    Returns OAuth2Util

  • setClientAuthentication(clientAuthentication): OAuth2Util

  • Parameters

    • clientAuthentication: string

    Returns OAuth2Util

setClientId

  • setClientId(clientId): OAuth2Util

  • Parameters

    • clientId: string

    Returns OAuth2Util

setClientSecret

  • setClientSecret(clientSecret): OAuth2Util

  • Parameters

    • clientSecret: string

    Returns OAuth2Util

setCodeVerifier

  • setCodeVerifier(codeVerifier): OAuth2Util

  • Parameters

    • codeVerifier: string

      A random, 43-128 character string used to connect the authorization request to the token request.

    Returns OAuth2Util

setDescription

  • setDescription(description): OAuth2Util

  • Parameters

    • description: string

      A short description for security scheme. CommonMark syntax MAY be used for rich text representation.

    Returns OAuth2Util

setGrantType

  • setGrantType(grantType): OAuth2Util

  • Parameters

    Returns OAuth2Util

  • setGrantType(grantType): OAuth2Util

  • Parameters

    • grantType: string

    Returns OAuth2Util

setHeaderPrefix

  • setHeaderPrefix(headerPrefix): OAuth2Util

  • Parameters

    • headerPrefix: string

      Added to the Authorization header before the access token.

    Returns OAuth2Util

setHost

  • setHost(host): this

  • Parameters

    • host: string

    Returns this

setPassword

  • setPassword(password): OAuth2Util

  • Parameters

    • password: string

    Returns OAuth2Util

setRedirectUri

  • setRedirectUri(redirectUri): OAuth2Util

  • Parameters

    • redirectUri: string

      This is the callback URL that you will be redirected to, after your application is authorized.

    Returns OAuth2Util

setRefreshUrl

  • setRefreshUrl(refreshUrl): OAuth2Util

  • Parameters

    • refreshUrl: string

    Returns OAuth2Util

setScopes

  • setScopes(scopes): OAuth2Util

  • Parameters

    • scopes: Record<string, string>

      The scopes of the access request. A map between the scope name and a short description for it. The map MAY be empty.

    Returns OAuth2Util

setState

  • setState(state): OAuth2Util

  • Parameters

    • state: string

      An opaque value that is used for preventing cross-site request forgery.

    Returns OAuth2Util

setTokenLocation

  • setTokenLocation(tokenLocation): OAuth2Util

  • Parameters

    Returns OAuth2Util

  • setTokenLocation(tokenLocation): OAuth2Util

  • Parameters

    • tokenLocation: string

    Returns OAuth2Util

setTokenName

  • setTokenName(tokenName): OAuth2Util

  • Parameters

    • tokenName: string

    Returns OAuth2Util

setUseBrowser

  • setUseBrowser(useBrowser): OAuth2Util

  • Parameters

    • useBrowser: boolean

      If true, authorize using browser.

    Returns OAuth2Util

setUsername

  • setUsername(username): OAuth2Util

  • Parameters

    • username: string

    Returns OAuth2Util

toOpenAPI

  • toOpenAPI(): Record<string, SecuritySchemeObject>

  • Returns Record<string, SecuritySchemeObject>

toOpenAPISecurity

  • toOpenAPISecurity(scopes?): SecurityRequirementObject[]

  • Parameters

    • Optionalscopes: string[]

    Returns SecurityRequirementObject[]

toPostman

  • toPostman(scopes?): Auth

  • Parameters

    • Optionalscopes: string[]

    Returns Auth

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
addScopeclientAuthenticationToBodyclientAuthenticationToHeadergetAccessTokenUrlgetAuthUrlgetChallengeAlgorithmgetClientAuthenticationgetClientIdgetClientSecretgetCodeVerifiergetDescriptiongetGrantTypegetHeaderPrefixgetHostgetPasswordgetRedirectUrigetRefreshUrlgetScopesgetScopesNamesgetSecuritySchemeNamegetStategetTokenLocationgetTokenNamegetUseBrowsergetUsernameremoveAccessTokenUrlremoveAuthUrlremoveChallengeAlgorithmremoveClientAuthenticationremoveClientIdremoveClientSecretremoveCodeVerifierremoveDescriptionremoveGrantTyperemoveHeaderPrefixremoveHostremovePasswordremoveRedirectUriremoveRefreshUrlremoveScopesremoveStateremoveTokenLocationremoveTokenNameremoveUseBrowserremoveUsernamesetAccessTokenUrlsetAuthUrlsetChallengeAlgorithmsetClientAuthenticationsetClientIdsetClientSecretsetCodeVerifiersetDescriptionsetGrantTypesetHeaderPrefixsetHostsetPasswordsetRedirectUrisetRefreshUrlsetScopessetStatesetTokenLocationsetTokenNamesetUseBrowsersetUsernametoOpenAPItoOpenAPISecuritytoPostman