• Preparing search index...
  • The search index is not available
javascript-sdk - v4.2.0
  • javascript-sdk - v4.2.0
  • http-client/helpers
  • buildAuthzOptions

Function buildAuthzOptions

  • buildAuthzOptions(authzObj: AuthorizationJSON, baseURL: string, timeout: number, realmPath?: string, customPaths?: CustomPathConfig): HttpClientRequestOptions
  • Parameters

    • authzObj: AuthorizationJSON
    • baseURL: string
    • timeout: number
    • Optional realmPath: string
    • Optional customPaths: CustomPathConfig

    Returns HttpClientRequestOptions

    • Defined in http-client/helpers.ts:65

Settings

Member Visibility

Theme

  • src
    • auth
      • enums.ts
        • ErrorCode
        • CallbackType
      • index.ts
        • Auth
      • interfaces.ts
        • Step
        • StepDetail
        • StepOptions
        • FailedPolicyRequirement
        • PolicyRequirement
        • PolicyParams
        • Callback
        • NameValue
    • config
      • constants.ts
        • DEFAULT_OAUTH_THRESHOLD
        • PREFIX
      • enums.ts
        • ActionTypes
      • index.ts
        • Config
        • ConfigOptions
        • ServerConfig
        • ValidConfigOptions
      • interfaces.ts
        • LogLevel
        • Action
        • LoggerFunctions
        • ConfigOptions
        • ConfigurablePaths
        • CustomPathConfig
        • RequestMiddleware
        • RequestObj
        • ServerConfig
        • TokenStoreObject
        • ValidConfigOptions
    • fr-auth
      • callbacks
        • attribute-input-callback.ts
          • AttributeInputCallback
        • choice-callback.ts
          • ChoiceCallback
        • confirmation-callback.ts
          • ConfirmationCallback
        • device-profile-callback.ts
          • DeviceProfileCallback
        • factory.ts
          • FRCallbackFactory
        • hidden-value-callback.ts
          • HiddenValueCallback
        • index.ts
          • FRCallback
        • kba-create-callback.ts
          • KbaCreateCallback
        • metadata-callback.ts
          • MetadataCallback
        • name-callback.ts
          • NameCallback
        • password-callback.ts
          • PasswordCallback
        • polling-wait-callback.ts
          • PollingWaitCallback
        • recaptcha-callback.ts
          • ReCaptchaCallback
        • redirect-callback.ts
          • RedirectCallback
        • select-idp-callback.ts
          • IdPValue
          • SelectIdPCallback
        • suspended-text-output-callback.ts
          • SuspendedTextOutputCallback
        • terms-and-conditions-callback.ts
          • TermsAndConditionsCallback
        • text-input-callback.ts
          • TextInputCallback
        • text-output-callback.ts
          • TextOutputCallback
        • validated-create-password-callback.ts
          • ValidatedCreatePasswordCallback
        • validated-create-username-callback.ts
          • ValidatedCreateUsernameCallback
      • enums.ts
        • StepType
      • fr-login-failure.ts
        • FRLoginFailure
      • fr-login-success.ts
        • FRLoginSuccess
      • fr-step.ts
        • FRStep
        • FRStepHandler
      • index.ts
        • FRAuth
      • interfaces.ts
        • AuthResponse
        • FailureDetail
    • fr-device
      • collector.ts
        • Collector
      • defaults.ts
        • browserProps
        • configurableCategories
        • delay
        • devicePlatforms
        • displayProps
        • fontNames
        • hardwareProps
        • platformProps
      • index.ts
        • FRDevice
      • interfaces.ts
        • Category
        • CollectParameters
        • DeviceProfileData
        • Geolocation
        • BaseProfileConfig
        • ProfileConfigOptions
    • fr-policy
      • enums.ts
        • PolicyKey
      • helpers.ts
        • getProp
      • index.ts
        • FRPolicy
        • MessageCreator
        • ProcessedPropertyError
        • PolicyKey
      • interfaces.ts
        • MessageCreator
        • ProcessedPropertyError
      • message-creator.ts
        • defaultMessageCreator
    • fr-recovery-codes
      • index.ts
        • FRRecoveryCodes
      • script-parser.ts
        • parseDisplayRecoveryCodesText
    • fr-user
      • index.ts
        • FRUser
    • fr-webauthn
      • enums.ts
        • WebAuthnOutcome
        • WebAuthnOutcomeType
        • WebAuthnStepType
      • helpers.ts
        • ensureArray
        • arrayBufferToString
        • getIndexOne
        • parseCredentials
        • parseNumberArray
        • parsePubKeyArray
        • parseAllowCredentialsArray
        • parseRelyingPartyId
      • index.ts
        • FRWebAuthn
        • RelyingParty
        • WebAuthnAuthenticationMetadata
        • WebAuthnCallbacks
        • WebAuthnRegistrationMetadata
        • WebAuthnOutcome
        • WebAuthnStepType
      • interfaces.ts
        • AttestationType
        • DeviceStepState
        • UserVerificationType
        • RelyingParty
        • ResponseCredential
        • Step
        • StepType
        • WebAuthnRegistrationMetadata
        • WebAuthnAuthenticationMetadata
        • WebAuthnCallbacks
        • WebAuthnTextOutputRegistration
        • ParsedCredential
      • script-parser.ts
        • parseWebAuthnRegisterText
        • parseWebAuthnAuthenticateText
    • http-client
      • helpers.ts
        • addAuthzInfoToHeaders
        • addAuthzInfoToURL
        • buildAuthzOptions
        • examineForIGAuthz
        • examineForIGAuthzHeader
        • examineForRESTAuthz
        • getAdvicesFromHeader
        • hasAuthzAdvice
        • isAuthzStep
        • newTokenRequired
        • normalizeIGRedirectResponseToAdviceJSON
        • normalizeIGJSONResponseToAdviceJSON
        • normalizeRESTJSON
      • index.ts
        • HttpClient
        • HttpClientRequestOptions
        • RequiresNewTokenFn
      • interfaces.ts
        • Advices
        • HandleStep
        • HttpClientRequestOptions
        • RequiresNewTokenFn
        • AuthorizationJSON
    • oauth2-client
      • enums.ts
        • ResponseType
      • index.ts
        • allowedErrors
        • OAuth2Client
        • GetAuthorizationUrlOptions
        • GetOAuth2TokensOptions
        • OAuth2Tokens
        • ResponseType
      • interfaces.ts
        • OAuth2Tokens
        • AccessTokenResponse
        • GetAuthorizationUrlOptions
        • GetOAuth2TokensOptions
    • session-manager
      • index.ts
        • SessionManager
    • shared
      • constants.ts
        • REQUESTED_WITH
      • interfaces.ts
        • StringDict
        • Tokens
      • types.ts
        • Noop
    • token-manager
      • helpers.ts
        • tokensWillExpireWithinThreshold
      • index.ts
        • GetTokensOptions
        • TokenManager
    • token-storage
      • constants.ts
        • index.ts
          • TokenStorage
        • interfaces.ts
          • local-storage.ts
            • LocalStorageWrapper
          • session-storage.ts
            • SessionStorageWrapper
        • user-manager
          • index.ts
            • UserManager
        • util
          • deferred.ts
            • Deferred
          • http.ts
            • isOkOr4xx
          • logger.ts
            • FRLogger
          • middleware.ts
            • middlewareWrapper
          • pkce.ts
            • PKCE
          • realm.ts
            • storage.ts
              • strings.ts
                • plural
              • timeout.ts
                • withTimeout
              • url.ts
                • getBaseUrl
                • getEndpointPath
                • resolve
                • parseQuery
                • stringify
            • index.ts
              • AuthResponse
              • Callback
              • ConfigOptions
              • FailureDetail
              • FRCallbackFactory
              • FRStepHandler
              • GetAuthorizationUrlOptions
              • GetOAuth2TokensOptions
              • GetTokensOptions
              • IdPValue
              • LoggerFunctions
              • MessageCreator
              • NameValue
              • OAuth2Tokens
              • PolicyRequirement
              • ProcessedPropertyError
              • RelyingParty
              • Step
              • StepDetail
              • Tokens
              • ValidConfigOptions
              • WebAuthnAuthenticationMetadata
              • WebAuthnCallbacks
              • WebAuthnRegistrationMetadata
              • defaultMessageCreator
              • AttributeInputCallback
              • Auth
              • CallbackType
              • ChoiceCallback
              • Config
              • ConfirmationCallback
              • Deferred
              • DeviceProfileCallback
              • ErrorCode
              • FRAuth
              • FRCallback
              • FRDevice
              • FRLoginFailure
              • FRLoginSuccess
              • FRPolicy
              • FRRecoveryCodes
              • FRStep
              • FRUser
              • FRWebAuthn
              • HiddenValueCallback
              • HttpClient
              • KbaCreateCallback
              • MetadataCallback
              • NameCallback
              • OAuth2Client
              • PasswordCallback
              • PKCE
              • PolicyKey
              • PollingWaitCallback
              • ReCaptchaCallback
              • RedirectCallback
              • ResponseType
              • SelectIdPCallback
              • SessionManager
              • StepType
              • SuspendedTextOutputCallback
              • TermsAndConditionsCallback
              • TextInputCallback
              • TextOutputCallback
              • TokenManager
              • TokenStorage
              • UserManager
              • ValidatedCreatePasswordCallback
              • ValidatedCreateUsernameCallback
              • WebAuthnOutcome
              • WebAuthnStepType
            • typings.test.d.ts