Safe Haskell	None
Language	Haskell2010

GitHub.Auth

Synopsis

data Auth
- = BasicAuth ByteString ByteString
- | OAuth Token
- | JWT JWTToken
- | EnterpriseOAuth Text Token
type Token = ByteString
type JWTToken = Text
class AuthMethod a
endpoint :: AuthMethod a => a -> Maybe Text
setAuthRequest :: AuthMethod a => a -> Request -> Request

Documentation

data Auth Source #

The Github auth data type

Constructors

BasicAuth ByteString ByteString	Username and password
OAuth Token	OAuth token
JWT JWTToken	JWT Token
EnterpriseOAuth Text Token	Custom endpoint and OAuth token

Instances

Instances details

Data Auth Source #

Instance details

Defined in GitHub.Auth

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Auth -> c Auth #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Auth #

toConstr :: Auth -> Constr #

dataTypeOf :: Auth -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Auth) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Auth) #

gmapT :: (forall b. Data b => b -> b) -> Auth -> Auth #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Auth -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Auth -> r #

gmapQ :: (forall d. Data d => d -> u) -> Auth -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Auth -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Auth -> m Auth #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Auth -> m Auth #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Auth -> m Auth #

Generic Auth Source #

Instance details

Defined in GitHub.Auth

Associated Types

type Rep Auth

Instance details

Defined in GitHub.Auth

type Rep Auth = D1 ('MetaData "Auth" "GitHub.Auth" "github-0.30-7PDLbEAlB9u1WnWZZQOkWM" 'False) ((C1 ('MetaCons "BasicAuth" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :+: C1 ('MetaCons "OAuth" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Token))) :+: (C1 ('MetaCons "JWT" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JWTToken)) :+: C1 ('MetaCons "EnterpriseOAuth" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Token))))

Methods

from :: Auth -> Rep Auth x #

to :: Rep Auth x -> Auth #

Show Auth Source #

Instance details

Defined in GitHub.Auth

Methods

showsPrec :: Int -> Auth -> ShowS #

show :: Auth -> String #

showList :: [Auth] -> ShowS #

Binary Auth Source #

Instance details

Defined in GitHub.Auth

Methods

put :: Auth -> Put #

get :: Get Auth #

putList :: [Auth] -> Put #

NFData Auth Source #

Instance details

Defined in GitHub.Auth

Methods

rnf :: Auth -> () #

Eq Auth Source #

Instance details

Defined in GitHub.Auth

Methods

(==) :: Auth -> Auth -> Bool #

(/=) :: Auth -> Auth -> Bool #

Ord Auth Source #

Instance details

Defined in GitHub.Auth

Methods

compare :: Auth -> Auth -> Ordering #

(<) :: Auth -> Auth -> Bool #

(<=) :: Auth -> Auth -> Bool #

(>) :: Auth -> Auth -> Bool #

(>=) :: Auth -> Auth -> Bool #

max :: Auth -> Auth -> Auth #

min :: Auth -> Auth -> Auth #

AuthMethod Auth Source #

Instance details

Defined in GitHub.Auth

Methods

endpoint :: Auth -> Maybe Text Source #

setAuthRequest :: Auth -> Request -> Request Source #

Hashable Auth Source #

Instance details

Defined in GitHub.Auth

Methods

hashWithSalt :: Int -> Auth -> Int #

hash :: Auth -> Int #

type Rep Auth Source #

Instance details

Defined in GitHub.Auth

type Rep Auth = D1 ('MetaData "Auth" "GitHub.Auth" "github-0.30-7PDLbEAlB9u1WnWZZQOkWM" 'False) ((C1 ('MetaCons "BasicAuth" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :+: C1 ('MetaCons "OAuth" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Token))) :+: (C1 ('MetaCons "JWT" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JWTToken)) :+: C1 ('MetaCons "EnterpriseOAuth" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Token))))

type Token = ByteString Source #

type JWTToken = Text Source #

class AuthMethod a Source #

A type class for different authentication methods

Note the () intance, which doee nothing, i.e. is unauthenticated.

Minimal complete definition

endpoint, setAuthRequest

Instances

Instances details

AuthMethod Auth Source #
Instance details Defined in GitHub.Auth Methods endpoint :: Auth -> Maybe Text Source # setAuthRequest :: Auth -> Request -> Request Source #
AuthMethod () Source #
Instance details Defined in GitHub.Auth Methods endpoint :: () -> Maybe Text Source # setAuthRequest :: () -> Request -> Request Source #

endpoint :: AuthMethod a => a -> Maybe Text Source #

Custom API endpoint without trailing slash

setAuthRequest :: AuthMethod a => a -> Request -> Request Source #

A function which sets authorisation on an HTTP request