Safe Haskell	None
Language	Haskell2010

StripeAPI.SecuritySchemes

Description

Contains all supported security schemes defined in the specification

Synopsis

data BasicAuthenticationSecurityScheme = BasicAuthenticationSecurityScheme {
- basicAuthenticationSecuritySchemeUsername :: Text
- basicAuthenticationSecuritySchemePassword :: Text
}
data BearerAuthenticationSecurityScheme = BearerAuthenticationSecurityScheme Text

Documentation

data BasicAuthenticationSecurityScheme 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
  { _securityScheme =
      BasicAuthenticationSecurityScheme
        { basicAuthenticationSecuritySchemeUsername = "user",
          basicAuthenticationSecuritySchemePassword = "pw"
        }
  }

Constructors

BasicAuthenticationSecurityScheme
Fields basicAuthenticationSecuritySchemeUsername :: Text basicAuthenticationSecuritySchemePassword :: Text

Instances

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

data BearerAuthenticationSecurityScheme 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
  { _securityScheme = BearerAuthenticationSecurityScheme "token"
  }

Constructors

BearerAuthenticationSecurityScheme Text

Instances

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