Data.Swagger.Model.Authorisation

The Authorisation Object part of the swagger specification. For construction please consider using Data.Swagger.Build.Authorisation.

Documentation

data Authorisation

Cf. Authorization Object

Constructors

BasicAuth

ApiKey

Fields

• passAs :: PassMethod
• keyname :: Text

OAuth2

Fields

• scopes :: Maybe [Scope]
• grantTypes :: GrantTypes

Instances

Show Authorisation

Methods

showsPrec :: Int -> Authorisation -> ShowS

show :: Authorisation -> String

showList :: [Authorisation] -> ShowS

ToJSON Authorisation

Methods

toJSON :: Authorisation -> Value

toEncoding :: Authorisation -> Encoding

toJSONList :: [Authorisation] -> Value

toEncodingList :: [Authorisation] -> Encoding

data PassMethod

Constructors

PassAsHeader

PassAsQuery

Instances

Eq PassMethod

Methods

(==) :: PassMethod -> PassMethod -> Bool

(/=) :: PassMethod -> PassMethod -> Bool

Show PassMethod

Methods

showsPrec :: Int -> PassMethod -> ShowS

show :: PassMethod -> String

showList :: [PassMethod] -> ShowS

ToJSON PassMethod

Methods

toJSON :: PassMethod -> Value

toEncoding :: PassMethod -> Encoding

toJSONList :: [PassMethod] -> Value

toEncodingList :: [PassMethod] -> Encoding

data Scope

Cf. Scope Object

Constructors

Scope

Fields

• scope :: Text
• description :: Maybe Text

Instances

Show Scope

Methods

showsPrec :: Int -> Scope -> ShowS

show :: Scope -> String

showList :: [Scope] -> ShowS

ToJSON Scope

Methods

toJSON :: Scope -> Value

toEncoding :: Scope -> Encoding

toJSONList :: [Scope] -> Value

toEncodingList :: [Scope] -> Encoding

data GrantTypes

Cf. Grant Types Object

Constructors

GrantTypes

Fields

• implicit :: Maybe ImplicitGrant
• authCode :: Maybe AuthCode

Instances

Show GrantTypes

Methods

showsPrec :: Int -> GrantTypes -> ShowS

show :: GrantTypes -> String

showList :: [GrantTypes] -> ShowS

ToJSON GrantTypes

Methods

toJSON :: GrantTypes -> Value

toEncoding :: GrantTypes -> Encoding

toJSONList :: [GrantTypes] -> Value

toEncodingList :: [GrantTypes] -> Encoding

data ImplicitGrant

Cf. Implicit Object

Constructors

ImplicitGrant

Fields

• loginEndpoint :: LoginEndpoint
• tokenName :: Maybe Text

Instances

Show ImplicitGrant

Methods

showsPrec :: Int -> ImplicitGrant -> ShowS

show :: ImplicitGrant -> String

showList :: [ImplicitGrant] -> ShowS

ToJSON ImplicitGrant

Methods

toJSON :: ImplicitGrant -> Value

toEncoding :: ImplicitGrant -> Encoding

toJSONList :: [ImplicitGrant] -> Value

toEncodingList :: [ImplicitGrant] -> Encoding

newtype LoginEndpoint

Constructors

LoginEndpoint

Fields

• loginUrl :: Text

Instances

Show LoginEndpoint

Methods

showsPrec :: Int -> LoginEndpoint -> ShowS

show :: LoginEndpoint -> String

showList :: [LoginEndpoint] -> ShowS

ToJSON LoginEndpoint

Methods

toJSON :: LoginEndpoint -> Value

toEncoding :: LoginEndpoint -> Encoding

toJSONList :: [LoginEndpoint] -> Value

toEncodingList :: [LoginEndpoint] -> Encoding

data AuthCode

Cf. Authorization Code Object

Constructors

AuthCode

Fields

• tokenRequestEndpoint :: TokenRequestEndpoint
• tokenEndpoint :: TokenEndpoint

Instances

Show AuthCode

Methods

showsPrec :: Int -> AuthCode -> ShowS

show :: AuthCode -> String

showList :: [AuthCode] -> ShowS

ToJSON AuthCode

Methods

toJSON :: AuthCode -> Value

toEncoding :: AuthCode -> Encoding

toJSONList :: [AuthCode] -> Value

toEncodingList :: [AuthCode] -> Encoding

data TokenRequestEndpoint

Cf. Token Request Endpoint Object

Constructors

TokenRequestEndpoint

Fields

• tokenRequestUrl :: Text
• clientIdName :: Maybe Text
• clientSecretName :: Maybe Text

Instances

Show TokenRequestEndpoint

Methods

showsPrec :: Int -> TokenRequestEndpoint -> ShowS

show :: TokenRequestEndpoint -> String

showList :: [TokenRequestEndpoint] -> ShowS

ToJSON TokenRequestEndpoint

Methods

toJSON :: TokenRequestEndpoint -> Value

toEncoding :: TokenRequestEndpoint -> Encoding

toJSONList :: [TokenRequestEndpoint] -> Value

toEncodingList :: [TokenRequestEndpoint] -> Encoding

data TokenEndpoint

Cf. Token Endpoint Object

Constructors

TokenEndpoint

Fields

• tokenEndpointUrl :: Text
• tokenEndpointTokenName :: Maybe Text

Instances

Show TokenEndpoint

Methods

showsPrec :: Int -> TokenEndpoint -> ShowS

show :: TokenEndpoint -> String

showList :: [TokenEndpoint] -> ShowS

ToJSON TokenEndpoint

Methods

toJSON :: TokenEndpoint -> Value

toEncoding :: TokenEndpoint -> Encoding

toJSONList :: [TokenEndpoint] -> Value

toEncodingList :: [TokenEndpoint] -> Encoding