Safe Haskell	None
Language	Haskell2010

Data.Swagger.Model.Authorisation

Description

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

Synopsis

data Authorisation
- = BasicAuth
- | ApiKey {
  - passAs :: PassMethod
  - keyname :: Text
  }
- | OAuth2 {
  - scopes :: Maybe [Scope]
  - grantTypes :: GrantTypes
  }
data PassMethod
- = PassAsHeader
- | PassAsQuery
data Scope = Scope {
- scope :: Text
- description :: Maybe Text
}
data GrantTypes = GrantTypes {
- implicit :: Maybe ImplicitGrant
- authCode :: Maybe AuthCode
}
data ImplicitGrant = ImplicitGrant {
- loginEndpoint :: LoginEndpoint
- tokenName :: Maybe Text
}
newtype LoginEndpoint = LoginEndpoint {
- loginUrl :: Text
}
data AuthCode = AuthCode {
- tokenRequestEndpoint :: TokenRequestEndpoint
- tokenEndpoint :: TokenEndpoint
}
data TokenRequestEndpoint = TokenRequestEndpoint {
- tokenRequestUrl :: Text
- clientIdName :: Maybe Text
- clientSecretName :: Maybe Text
}
data TokenEndpoint = TokenEndpoint {
- tokenEndpointUrl :: Text
- tokenEndpointTokenName :: Maybe Text
}

Documentation

data Authorisation #

Cf. Authorization Object

Constructors

BasicAuth
ApiKey
Fields passAs :: PassMethod keyname :: Text
OAuth2
Fields scopes :: Maybe [Scope] grantTypes :: GrantTypes

Instances

Show Authorisation #
Instance details Defined in Data.Swagger.Model.Authorisation Methods showsPrec :: Int -> Authorisation -> ShowS # show :: Authorisation -> String # showList :: [Authorisation] -> ShowS #
ToJSON Authorisation #
Instance details Defined in Data.Swagger.Model.Authorisation Methods toJSON :: Authorisation -> Value # toEncoding :: Authorisation -> Encoding # toJSONList :: [Authorisation] -> Value # toEncodingList :: [Authorisation] -> Encoding #

data PassMethod #

Constructors

PassAsHeader
PassAsQuery

Instances

Eq PassMethod #
Instance details Defined in Data.Swagger.Model.Authorisation Methods (==) :: PassMethod -> PassMethod -> Bool # (/=) :: PassMethod -> PassMethod -> Bool #
Show PassMethod #
Instance details Defined in Data.Swagger.Model.Authorisation Methods showsPrec :: Int -> PassMethod -> ShowS # show :: PassMethod -> String # showList :: [PassMethod] -> ShowS #
ToJSON PassMethod #
Instance details Defined in Data.Swagger.Model.Authorisation 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 #
Instance details Defined in Data.Swagger.Model.Authorisation Methods showsPrec :: Int -> Scope -> ShowS # show :: Scope -> String # showList :: [Scope] -> ShowS #
ToJSON Scope #
Instance details Defined in Data.Swagger.Model.Authorisation 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 #
Instance details Defined in Data.Swagger.Model.Authorisation Methods showsPrec :: Int -> GrantTypes -> ShowS # show :: GrantTypes -> String # showList :: [GrantTypes] -> ShowS #
ToJSON GrantTypes #
Instance details Defined in Data.Swagger.Model.Authorisation 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 #
Instance details Defined in Data.Swagger.Model.Authorisation Methods showsPrec :: Int -> ImplicitGrant -> ShowS # show :: ImplicitGrant -> String # showList :: [ImplicitGrant] -> ShowS #
ToJSON ImplicitGrant #
Instance details Defined in Data.Swagger.Model.Authorisation Methods toJSON :: ImplicitGrant -> Value # toEncoding :: ImplicitGrant -> Encoding # toJSONList :: [ImplicitGrant] -> Value # toEncodingList :: [ImplicitGrant] -> Encoding #

newtype LoginEndpoint #

Constructors

LoginEndpoint
Fields loginUrl :: Text

Instances

Show LoginEndpoint #
Instance details Defined in Data.Swagger.Model.Authorisation Methods showsPrec :: Int -> LoginEndpoint -> ShowS # show :: LoginEndpoint -> String # showList :: [LoginEndpoint] -> ShowS #
ToJSON LoginEndpoint #
Instance details Defined in Data.Swagger.Model.Authorisation 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 #
Instance details Defined in Data.Swagger.Model.Authorisation Methods showsPrec :: Int -> AuthCode -> ShowS # show :: AuthCode -> String # showList :: [AuthCode] -> ShowS #
ToJSON AuthCode #
Instance details Defined in Data.Swagger.Model.Authorisation 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 #
Instance details Defined in Data.Swagger.Model.Authorisation Methods showsPrec :: Int -> TokenRequestEndpoint -> ShowS # show :: TokenRequestEndpoint -> String # showList :: [TokenRequestEndpoint] -> ShowS #
ToJSON TokenRequestEndpoint #
Instance details Defined in Data.Swagger.Model.Authorisation 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 #
Instance details Defined in Data.Swagger.Model.Authorisation Methods showsPrec :: Int -> TokenEndpoint -> ShowS # show :: TokenEndpoint -> String # showList :: [TokenEndpoint] -> ShowS #
ToJSON TokenEndpoint #
Instance details Defined in Data.Swagger.Model.Authorisation Methods toJSON :: TokenEndpoint -> Value # toEncoding :: TokenEndpoint -> Encoding # toJSONList :: [TokenEndpoint] -> Value # toEncodingList :: [TokenEndpoint] -> Encoding #