Copyright	(c) CNRS 2017-Present
License	AGPL + CECILL v3
Maintainer	team@gargantext.org
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Admin.Auth.Types

Description

Synopsis

data AuthRequest = AuthRequest {
- _authReq_username :: Username
- _authReq_password :: GargPassword
}
data AuthResponse = AuthResponse {
- _authRes_token :: Token
- _authRes_tree_id :: TreeId
- _authRes_user_id :: UserId
}
type Token = Text
type TreeId = NodeId
data CheckAuth
- = InvalidUser
- | InvalidPassword
- | Valid Token TreeId UserId
data AuthenticatedUser = AuthenticatedUser {
- _auth_node_id :: NodeId
- _auth_user_id :: UserId
}
auth_user_id :: Lens' AuthenticatedUser UserId
auth_node_id :: Lens' AuthenticatedUser NodeId
data AuthenticationError
type AuthContext = '[JWTSettings, CookieSettings]
data PathId
- = PathNode NodeId
- | PathNodeNode ListId DocId
type Email = Text
type Password = Text
data ForgotPasswordRequest = ForgotPasswordRequest {
- _fpReq_email :: Email
}
data ForgotPasswordResponse = ForgotPasswordResponse {
- _fpRes_status :: Text
}
data ForgotPasswordGet = ForgotPasswordGet {
- _fpGet_password :: Password
}
authRes_user_id :: Lens' AuthResponse UserId
authRes_tree_id :: Lens' AuthResponse TreeId
authRes_token :: Lens' AuthResponse Token

Documentation

data AuthRequest #

Main types for AUTH API

Constructors

AuthRequest
Fields _authReq_username :: Username _authReq_password :: GargPassword

Instances

Instances details

Arbitrary AuthRequest #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods arbitrary :: Gen AuthRequest # shrink :: AuthRequest -> [AuthRequest] #
FromJSON AuthRequest #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods parseJSON :: Value -> Parser AuthRequest # parseJSONList :: Value -> Parser [AuthRequest] #
ToJSON AuthRequest #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods toJSON :: AuthRequest -> Value # toEncoding :: AuthRequest -> Encoding # toJSONList :: [AuthRequest] -> Value # toEncodingList :: [AuthRequest] -> Encoding #
Generic AuthRequest #
Instance details Defined in Gargantext.API.Admin.Auth.Types Associated Types type Rep AuthRequest :: Type -> Type # Methods from :: AuthRequest -> Rep AuthRequest x # to :: Rep AuthRequest x -> AuthRequest #
ToSchema AuthRequest #	Instances
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods declareNamedSchema :: Proxy AuthRequest -> Declare (Definitions Schema) NamedSchema #
HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
type Rep AuthRequest #
Instance details Defined in Gargantext.API.Admin.Auth.Types type Rep AuthRequest = D1 ('MetaData "AuthRequest" "Gargantext.API.Admin.Auth.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "AuthRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "_authReq_username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :*: S1 ('MetaSel ('Just "_authReq_password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GargPassword)))

data AuthResponse #

Constructors

AuthResponse
Fields _authRes_token :: Token _authRes_tree_id :: TreeId _authRes_user_id :: UserId

Instances

Instances details

Arbitrary AuthResponse #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods arbitrary :: Gen AuthResponse # shrink :: AuthResponse -> [AuthResponse] #
FromJSON AuthResponse #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods parseJSON :: Value -> Parser AuthResponse # parseJSONList :: Value -> Parser [AuthResponse] #
ToJSON AuthResponse #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods toJSON :: AuthResponse -> Value # toEncoding :: AuthResponse -> Encoding # toJSONList :: [AuthResponse] -> Value # toEncodingList :: [AuthResponse] -> Encoding #
Generic AuthResponse #
Instance details Defined in Gargantext.API.Admin.Auth.Types Associated Types type Rep AuthResponse :: Type -> Type # Methods from :: AuthResponse -> Rep AuthResponse x # to :: Rep AuthResponse x -> AuthResponse #
Show AuthResponse #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods showsPrec :: Int -> AuthResponse -> ShowS # show :: AuthResponse -> String # showList :: [AuthResponse] -> ShowS #
Eq AuthResponse #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods (==) :: AuthResponse -> AuthResponse -> Bool # (/=) :: AuthResponse -> AuthResponse -> Bool #
ToSchema AuthResponse #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods declareNamedSchema :: Proxy AuthResponse -> Declare (Definitions Schema) NamedSchema #
HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
type Rep AuthResponse #
Instance details Defined in Gargantext.API.Admin.Auth.Types type Rep AuthResponse = D1 ('MetaData "AuthResponse" "Gargantext.API.Admin.Auth.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "AuthResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "_authRes_token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Token) :: (S1 ('MetaSel ('Just "_authRes_tree_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TreeId) :: S1 ('MetaSel ('Just "_authRes_user_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserId))))

type Token = Text #

type TreeId = NodeId #

data CheckAuth #

Constructors

InvalidUser
InvalidPassword
Valid Token TreeId UserId

Instances

Instances details

Eq CheckAuth #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods (==) :: CheckAuth -> CheckAuth -> Bool # (/=) :: CheckAuth -> CheckAuth -> Bool #

data AuthenticatedUser #

Constructors

AuthenticatedUser
Fields _auth_node_id :: NodeId _auth_user_id :: UserId

Instances

Instances details

FromJSON AuthenticatedUser #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods parseJSON :: Value -> Parser AuthenticatedUser # parseJSONList :: Value -> Parser [AuthenticatedUser] #
ToJSON AuthenticatedUser #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods toJSON :: AuthenticatedUser -> Value # toEncoding :: AuthenticatedUser -> Encoding # toJSONList :: [AuthenticatedUser] -> Value # toEncodingList :: [AuthenticatedUser] -> Encoding #
Generic AuthenticatedUser #
Instance details Defined in Gargantext.API.Admin.Auth.Types Associated Types type Rep AuthenticatedUser :: Type -> Type # Methods from :: AuthenticatedUser -> Rep AuthenticatedUser x # to :: Rep AuthenticatedUser x -> AuthenticatedUser #
FromJWT AuthenticatedUser #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods decodeJWT :: ClaimsSet -> Either Text AuthenticatedUser #
ToJWT AuthenticatedUser #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods encodeJWT :: AuthenticatedUser -> ClaimsSet #
ToSchema AuthenticatedUser #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods declareNamedSchema :: Proxy AuthenticatedUser -> Declare (Definitions Schema) NamedSchema #
HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
type Rep AuthenticatedUser #
Instance details Defined in Gargantext.API.Admin.Auth.Types type Rep AuthenticatedUser = D1 ('MetaData "AuthenticatedUser" "Gargantext.API.Admin.Auth.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "AuthenticatedUser" 'PrefixI 'True) (S1 ('MetaSel ('Just "_auth_node_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NodeId) :*: S1 ('MetaSel ('Just "_auth_user_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserId)))

auth_user_id :: Lens' AuthenticatedUser UserId #

auth_node_id :: Lens' AuthenticatedUser NodeId #

data AuthenticationError #

Constructors

LoginFailed NodeId UserId Error
InvalidUsernameOrPassword
UserNotAuthorized UserId Text

Instances

Instances details

Show AuthenticationError #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods showsPrec :: Int -> AuthenticationError -> ShowS # show :: AuthenticationError -> String # showList :: [AuthenticationError] -> ShowS #
Eq AuthenticationError #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods (==) :: AuthenticationError -> AuthenticationError -> Bool # (/=) :: AuthenticationError -> AuthenticationError -> Bool #

type AuthContext = '[JWTSettings, CookieSettings] #

data PathId #

Constructors

PathNode NodeId
PathNodeNode ListId DocId

type Email = Text #

type Password = Text #

data ForgotPasswordRequest #

Constructors

ForgotPasswordRequest
Fields _fpReq_email :: Email

Instances

Instances details

FromJSON ForgotPasswordRequest #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods parseJSON :: Value -> Parser ForgotPasswordRequest # parseJSONList :: Value -> Parser [ForgotPasswordRequest] #
ToJSON ForgotPasswordRequest #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods toJSON :: ForgotPasswordRequest -> Value # toEncoding :: ForgotPasswordRequest -> Encoding # toJSONList :: [ForgotPasswordRequest] -> Value # toEncodingList :: [ForgotPasswordRequest] -> Encoding #
Generic ForgotPasswordRequest #
Instance details Defined in Gargantext.API.Admin.Auth.Types Associated Types type Rep ForgotPasswordRequest :: Type -> Type # Methods from :: ForgotPasswordRequest -> Rep ForgotPasswordRequest x # to :: Rep ForgotPasswordRequest x -> ForgotPasswordRequest #
ToSchema ForgotPasswordRequest #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods declareNamedSchema :: Proxy ForgotPasswordRequest -> Declare (Definitions Schema) NamedSchema #
HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
type Rep ForgotPasswordRequest #
Instance details Defined in Gargantext.API.Admin.Auth.Types type Rep ForgotPasswordRequest = D1 ('MetaData "ForgotPasswordRequest" "Gargantext.API.Admin.Auth.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "ForgotPasswordRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "_fpReq_email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Email)))

data ForgotPasswordResponse #

Constructors

ForgotPasswordResponse
Fields _fpRes_status :: Text

Instances

Instances details

FromJSON ForgotPasswordResponse #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods parseJSON :: Value -> Parser ForgotPasswordResponse # parseJSONList :: Value -> Parser [ForgotPasswordResponse] #
ToJSON ForgotPasswordResponse #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods toJSON :: ForgotPasswordResponse -> Value # toEncoding :: ForgotPasswordResponse -> Encoding # toJSONList :: [ForgotPasswordResponse] -> Value # toEncodingList :: [ForgotPasswordResponse] -> Encoding #
Generic ForgotPasswordResponse #
Instance details Defined in Gargantext.API.Admin.Auth.Types Associated Types type Rep ForgotPasswordResponse :: Type -> Type # Methods from :: ForgotPasswordResponse -> Rep ForgotPasswordResponse x # to :: Rep ForgotPasswordResponse x -> ForgotPasswordResponse #
ToSchema ForgotPasswordResponse #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods declareNamedSchema :: Proxy ForgotPasswordResponse -> Declare (Definitions Schema) NamedSchema #
HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
type Rep ForgotPasswordResponse #
Instance details Defined in Gargantext.API.Admin.Auth.Types type Rep ForgotPasswordResponse = D1 ('MetaData "ForgotPasswordResponse" "Gargantext.API.Admin.Auth.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "ForgotPasswordResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "_fpRes_status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

data ForgotPasswordGet #

Constructors

ForgotPasswordGet
Fields _fpGet_password :: Password

Instances

Instances details

FromJSON ForgotPasswordGet #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods parseJSON :: Value -> Parser ForgotPasswordGet # parseJSONList :: Value -> Parser [ForgotPasswordGet] #
ToJSON ForgotPasswordGet #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods toJSON :: ForgotPasswordGet -> Value # toEncoding :: ForgotPasswordGet -> Encoding # toJSONList :: [ForgotPasswordGet] -> Value # toEncodingList :: [ForgotPasswordGet] -> Encoding #
Generic ForgotPasswordGet #
Instance details Defined in Gargantext.API.Admin.Auth.Types Associated Types type Rep ForgotPasswordGet :: Type -> Type # Methods from :: ForgotPasswordGet -> Rep ForgotPasswordGet x # to :: Rep ForgotPasswordGet x -> ForgotPasswordGet #
ToSchema ForgotPasswordGet #
Instance details Defined in Gargantext.API.Admin.Auth.Types Methods declareNamedSchema :: Proxy ForgotPasswordGet -> Declare (Definitions Schema) NamedSchema #
HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
type Rep ForgotPasswordGet #
Instance details Defined in Gargantext.API.Admin.Auth.Types type Rep ForgotPasswordGet = D1 ('MetaData "ForgotPasswordGet" "Gargantext.API.Admin.Auth.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "ForgotPasswordGet" 'PrefixI 'True) (S1 ('MetaSel ('Just "_fpGet_password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Password)))

authRes_user_id :: Lens' AuthResponse UserId #

authRes_tree_id :: Lens' AuthResponse TreeId #

authRes_token :: Lens' AuthResponse Token #