Safe Haskell	None
Language	Haskell2010

StripeAPI.SecuritySchemes

Description

Contains all supported security schemes defined in the specification

Synopsis

data BasicAuthenticationData = BasicAuthenticationData {
- basicAuthenticationDataUsername :: Text
- basicAuthenticationDataPassword :: Text
}
basicAuthenticationSecurityScheme :: BasicAuthenticationData -> SecurityScheme
bearerAuthenticationSecurityScheme :: Text -> SecurityScheme

Documentation

data BasicAuthenticationData Source #

Used to pass the authentication information for BasicAuthentication to basicAuthenticationSecurityScheme.

Constructors

BasicAuthenticationData
Fields basicAuthenticationDataUsername :: Text basicAuthenticationDataPassword :: Text

Instances

Instances details

Eq BasicAuthenticationData Source #
Instance details Defined in StripeAPI.SecuritySchemes Methods (==) :: BasicAuthenticationData -> BasicAuthenticationData -> Bool # (/=) :: BasicAuthenticationData -> BasicAuthenticationData -> Bool #
Ord BasicAuthenticationData Source #
Instance details Defined in StripeAPI.SecuritySchemes Methods compare :: BasicAuthenticationData -> BasicAuthenticationData -> Ordering # (<) :: BasicAuthenticationData -> BasicAuthenticationData -> Bool # (<=) :: BasicAuthenticationData -> BasicAuthenticationData -> Bool # (>) :: BasicAuthenticationData -> BasicAuthenticationData -> Bool # (>=) :: BasicAuthenticationData -> BasicAuthenticationData -> Bool # max :: BasicAuthenticationData -> BasicAuthenticationData -> BasicAuthenticationData # min :: BasicAuthenticationData -> BasicAuthenticationData -> BasicAuthenticationData #
Show BasicAuthenticationData Source #
Instance details Defined in StripeAPI.SecuritySchemes Methods showsPrec :: Int -> BasicAuthenticationData -> ShowS # show :: BasicAuthenticationData -> String # showList :: [BasicAuthenticationData] -> ShowS #

basicAuthenticationSecurityScheme :: BasicAuthenticationData -> SecurityScheme Source #

Use this security scheme to use basic authentication for a request. Should be used in a Configuration.

Basic HTTP authentication. Allowed headers-- Authorization: Basic <api_key> | Authorization: Basic <base64 hash of `api_key:`>

defaultConfiguration
  { configSecurityScheme =
      basicAuthenticationSecurityScheme BasicAuthenticationData
        { basicAuthenticationDataUsername = "user",
          basicAuthenticationDataPassword = "pw"
        }
  }

bearerAuthenticationSecurityScheme :: Text -> SecurityScheme Source #

Use this security scheme to use bearer authentication for a request. Should be used in a Configuration.

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

defaultConfiguration
  { configSecurityScheme = bearerAuthenticationSecurityScheme "token"
  }