Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.User.Auth

Contents

Login
Cookies
Token
Access
Servant

Synopsis

data Login = MkLogin {
- lId :: LoginId
- lPassword :: PlainTextPassword6
- lLabel :: Maybe CookieLabel
- lCode :: Maybe Value
}
newtype LoginCode = LoginCode {
- fromLoginCode :: Text
}
data LoginId
- = LoginByEmail EmailAddress
- | LoginByHandle Handle
data PendingLoginCode = PendingLoginCode {
- pendingLoginCode :: LoginCode
- pendingLoginTimeout :: Timeout
}
data SendLoginCode = SendLoginCode {
- lcPhone :: Phone
- lcCall :: Bool
- lcForce :: Bool
}
newtype LoginCodeTimeout = LoginCodeTimeout {
- fromLoginCodeTimeout :: Timeout
}
data CookieList = CookieList {
- cookieList :: [Cookie ()]
}
newtype CookieId = CookieId {
- cookieIdNum :: Word32
}
data CookieType
- = SessionCookie
- | PersistentCookie
data Cookie a = Cookie {
- cookieId :: CookieId
- cookieType :: CookieType
- cookieCreated :: UTCTime
- cookieExpires :: UTCTime
- cookieLabel :: Maybe CookieLabel
- cookieSucc :: Maybe CookieId
- cookieValue :: a
}
newtype CookieLabel = CookieLabel {
- cookieLabelText :: Text
}
data RemoveCookies = RemoveCookies {
- rmCookiesPassword :: PlainTextPassword6
- rmCookiesLabels :: [CookieLabel]
- rmCookiesIdents :: [CookieId]
}
toUnitCookie :: Cookie a -> Cookie ()
data AccessToken = AccessToken {
- user :: UserId
- access :: LByteString
- tokenType :: TokenType
- expiresIn :: Integer
}
bearerToken :: UserId -> LByteString -> Integer -> AccessToken
data TokenType = Bearer
data SomeUserToken
- = PlainUserToken (Token User)
- | LHUserToken (Token LegalHoldUser)
data SomeAccessToken
- = PlainAccessToken (Token Access)
- | LHAccessToken (Token LegalHoldAccess)
data UserTokenCookie = UserTokenCookie {
- utcExpires :: Maybe UTCTime
- utcToken :: SomeUserToken
- utcSecure :: Bool
}
data ProviderToken = ProviderToken (Token Provider)
data ProviderTokenCookie = ProviderTokenCookie {
- ptcToken :: ProviderToken
- ptcSecure :: Bool
}
data AccessWithCookie c = Access {
- accessToken :: !AccessToken
- accessCookie :: !(Maybe c)
}
type Access u = AccessWithCookie (Cookie (Token u))
type SomeAccess = AccessWithCookie UserTokenCookie
type TokenResponse = WithHeaders '[OptHeader (Header "Set-Cookie" UserTokenCookie)] SomeAccess (Respond 200 "OK" AccessToken)

Login

data Login Source #

Constructors

MkLogin
Fields lId :: LoginId lPassword :: PlainTextPassword6 lLabel :: Maybe CookieLabel lCode :: Maybe Value

Instances

Instances details

Arbitrary Login Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen Login Source # shrink :: Login -> [Login] Source #
FromJSON Login Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser Login Source # parseJSONList :: Value -> Parser [Login] Source #
ToJSON Login Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: Login -> Value Source # toEncoding :: Login -> Encoding Source # toJSONList :: [Login] -> Value Source # toEncodingList :: [Login] -> Encoding Source #
Generic Login Source #
Instance details Defined in Wire.API.User.Auth Associated Types type Rep Login :: Type -> Type # Methods from :: Login -> Rep Login x # to :: Rep Login x -> Login #
Show Login Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> Login -> ShowS # show :: Login -> String # showList :: [Login] -> ShowS #
Eq Login Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: Login -> Login -> Bool # (/=) :: Login -> Login -> Bool #
ToSchema Login Source #
Instance details Defined in Wire.API.User.Auth Methods declareNamedSchema :: Proxy Login -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Login Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc Login Source #
type Rep Login Source #
Instance details Defined in Wire.API.User.Auth type Rep Login = D1 ('MetaData "Login" "Wire.API.User.Auth" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "MkLogin" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LoginId) :: S1 ('MetaSel ('Just "lPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PlainTextPassword6)) :: (S1 ('MetaSel ('Just "lLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CookieLabel)) :*: S1 ('MetaSel ('Just "lCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Value)))))

newtype LoginCode Source #

A single-use login code.

Constructors

LoginCode
Fields fromLoginCode :: Text

Instances

Instances details

Arbitrary LoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen LoginCode Source # shrink :: LoginCode -> [LoginCode] Source #
FromJSON LoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser LoginCode Source # parseJSONList :: Value -> Parser [LoginCode] Source #
ToJSON LoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: LoginCode -> Value Source # toEncoding :: LoginCode -> Encoding Source # toJSONList :: [LoginCode] -> Value Source # toEncodingList :: [LoginCode] -> Encoding Source #
Show LoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> LoginCode -> ShowS # show :: LoginCode -> String # showList :: [LoginCode] -> ShowS #
Cql LoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods ctype :: Tagged LoginCode ColumnType Source # toCql :: LoginCode -> Value Source # fromCql :: Value -> Either String LoginCode Source #
Eq LoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: LoginCode -> LoginCode -> Bool # (/=) :: LoginCode -> LoginCode -> Bool #
ToSchema LoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods declareNamedSchema :: Proxy LoginCode -> Declare (Definitions Schema) NamedSchema Source #
ToSchema LoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc LoginCode Source #

data LoginId Source #

The login ID for client API versions v0..v5

Constructors

LoginByEmail EmailAddress
LoginByHandle Handle

Instances

Instances details

Arbitrary LoginId Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen LoginId Source # shrink :: LoginId -> [LoginId] Source #
FromJSON LoginId Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser LoginId Source # parseJSONList :: Value -> Parser [LoginId] Source #
ToJSON LoginId Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: LoginId -> Value Source # toEncoding :: LoginId -> Encoding Source # toJSONList :: [LoginId] -> Value Source # toEncodingList :: [LoginId] -> Encoding Source #
Generic LoginId Source #
Instance details Defined in Wire.API.User.Auth Associated Types type Rep LoginId :: Type -> Type # Methods from :: LoginId -> Rep LoginId x # to :: Rep LoginId x -> LoginId #
Show LoginId Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> LoginId -> ShowS # show :: LoginId -> String # showList :: [LoginId] -> ShowS #
Eq LoginId Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: LoginId -> LoginId -> Bool # (/=) :: LoginId -> LoginId -> Bool #
ToSchema LoginId Source #
Instance details Defined in Wire.API.User.Auth Methods declareNamedSchema :: Proxy LoginId -> Declare (Definitions Schema) NamedSchema Source #
ToSchema LoginId Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc LoginId Source #
type Rep LoginId Source #
Instance details Defined in Wire.API.User.Auth type Rep LoginId = D1 ('MetaData "LoginId" "Wire.API.User.Auth" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "LoginByEmail" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EmailAddress)) :+: C1 ('MetaCons "LoginByHandle" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Handle)))

data PendingLoginCode Source #

Used for internal endpoint only.

Constructors

PendingLoginCode
Fields pendingLoginCode :: LoginCode pendingLoginTimeout :: Timeout

Instances

Instances details

Arbitrary PendingLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen PendingLoginCode Source # shrink :: PendingLoginCode -> [PendingLoginCode] Source #
FromJSON PendingLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser PendingLoginCode Source # parseJSONList :: Value -> Parser [PendingLoginCode] Source #
ToJSON PendingLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: PendingLoginCode -> Value Source # toEncoding :: PendingLoginCode -> Encoding Source # toJSONList :: [PendingLoginCode] -> Value Source # toEncodingList :: [PendingLoginCode] -> Encoding Source #
Generic PendingLoginCode Source #
Instance details Defined in Wire.API.User.Auth Associated Types type Rep PendingLoginCode :: Type -> Type # Methods from :: PendingLoginCode -> Rep PendingLoginCode x # to :: Rep PendingLoginCode x -> PendingLoginCode #
Show PendingLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> PendingLoginCode -> ShowS # show :: PendingLoginCode -> String # showList :: [PendingLoginCode] -> ShowS #
Eq PendingLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: PendingLoginCode -> PendingLoginCode -> Bool # (/=) :: PendingLoginCode -> PendingLoginCode -> Bool #
ToSchema PendingLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods declareNamedSchema :: Proxy PendingLoginCode -> Declare (Definitions Schema) NamedSchema Source #
ToSchema PendingLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc PendingLoginCode Source #
type Rep PendingLoginCode Source #
Instance details Defined in Wire.API.User.Auth type Rep PendingLoginCode = D1 ('MetaData "PendingLoginCode" "Wire.API.User.Auth" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "PendingLoginCode" 'PrefixI 'True) (S1 ('MetaSel ('Just "pendingLoginCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LoginCode) :*: S1 ('MetaSel ('Just "pendingLoginTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Timeout)))

data SendLoginCode Source #

A request for sending a LoginCode

Constructors

SendLoginCode
Fields lcPhone :: Phone lcCall :: Bool lcForce :: Bool

Instances

Instances details

Arbitrary SendLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen SendLoginCode Source # shrink :: SendLoginCode -> [SendLoginCode] Source #
FromJSON SendLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser SendLoginCode Source # parseJSONList :: Value -> Parser [SendLoginCode] Source #
ToJSON SendLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: SendLoginCode -> Value Source # toEncoding :: SendLoginCode -> Encoding Source # toJSONList :: [SendLoginCode] -> Value Source # toEncodingList :: [SendLoginCode] -> Encoding Source #
Generic SendLoginCode Source #
Instance details Defined in Wire.API.User.Auth Associated Types type Rep SendLoginCode :: Type -> Type # Methods from :: SendLoginCode -> Rep SendLoginCode x # to :: Rep SendLoginCode x -> SendLoginCode #
Show SendLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> SendLoginCode -> ShowS # show :: SendLoginCode -> String # showList :: [SendLoginCode] -> ShowS #
Eq SendLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: SendLoginCode -> SendLoginCode -> Bool # (/=) :: SendLoginCode -> SendLoginCode -> Bool #
ToSchema SendLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods declareNamedSchema :: Proxy SendLoginCode -> Declare (Definitions Schema) NamedSchema Source #
ToSchema SendLoginCode Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc SendLoginCode Source #
type Rep SendLoginCode Source #
Instance details Defined in Wire.API.User.Auth type Rep SendLoginCode = D1 ('MetaData "SendLoginCode" "Wire.API.User.Auth" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "SendLoginCode" 'PrefixI 'True) (S1 ('MetaSel ('Just "lcPhone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Phone) :: (S1 ('MetaSel ('Just "lcCall") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "lcForce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

newtype LoginCodeTimeout Source #

A timeout for a new or pending login code.

Constructors

LoginCodeTimeout
Fields fromLoginCodeTimeout :: Timeout

Instances

Instances details

Arbitrary LoginCodeTimeout Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen LoginCodeTimeout Source # shrink :: LoginCodeTimeout -> [LoginCodeTimeout] Source #
FromJSON LoginCodeTimeout Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser LoginCodeTimeout Source # parseJSONList :: Value -> Parser [LoginCodeTimeout] Source #
ToJSON LoginCodeTimeout Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: LoginCodeTimeout -> Value Source # toEncoding :: LoginCodeTimeout -> Encoding Source # toJSONList :: [LoginCodeTimeout] -> Value Source # toEncodingList :: [LoginCodeTimeout] -> Encoding Source #
Show LoginCodeTimeout Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> LoginCodeTimeout -> ShowS # show :: LoginCodeTimeout -> String # showList :: [LoginCodeTimeout] -> ShowS #
Eq LoginCodeTimeout Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: LoginCodeTimeout -> LoginCodeTimeout -> Bool # (/=) :: LoginCodeTimeout -> LoginCodeTimeout -> Bool #
ToSchema LoginCodeTimeout Source #
Instance details Defined in Wire.API.User.Auth Methods declareNamedSchema :: Proxy LoginCodeTimeout -> Declare (Definitions Schema) NamedSchema Source #
ToSchema LoginCodeTimeout Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc LoginCodeTimeout Source #

Cookies

data CookieList Source #

Constructors

CookieList
Fields cookieList :: [Cookie ()]

Instances

Instances details

Arbitrary CookieList Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen CookieList Source # shrink :: CookieList -> [CookieList] Source #
FromJSON CookieList Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser CookieList Source # parseJSONList :: Value -> Parser [CookieList] Source #
ToJSON CookieList Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: CookieList -> Value Source # toEncoding :: CookieList -> Encoding Source # toJSONList :: [CookieList] -> Value Source # toEncodingList :: [CookieList] -> Encoding Source #
Generic CookieList Source #
Instance details Defined in Wire.API.User.Auth Associated Types type Rep CookieList :: Type -> Type # Methods from :: CookieList -> Rep CookieList x # to :: Rep CookieList x -> CookieList #
Show CookieList Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> CookieList -> ShowS # show :: CookieList -> String # showList :: [CookieList] -> ShowS #
Eq CookieList Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: CookieList -> CookieList -> Bool # (/=) :: CookieList -> CookieList -> Bool #
ToSchema CookieList Source #
Instance details Defined in Wire.API.User.Auth Methods declareNamedSchema :: Proxy CookieList -> Declare (Definitions Schema) NamedSchema Source #
ToSchema CookieList Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc CookieList Source #
type Rep CookieList Source #
Instance details Defined in Wire.API.User.Auth type Rep CookieList = D1 ('MetaData "CookieList" "Wire.API.User.Auth" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "CookieList" 'PrefixI 'True) (S1 ('MetaSel ('Just "cookieList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Cookie ()])))

newtype CookieId Source #

Constructors

CookieId
Fields cookieIdNum :: Word32

Instances

Instances details

Arbitrary CookieId Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen CookieId Source # shrink :: CookieId -> [CookieId] Source #
FromJSON CookieId Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser CookieId Source # parseJSONList :: Value -> Parser [CookieId] Source #
ToJSON CookieId Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: CookieId -> Value Source # toEncoding :: CookieId -> Encoding Source # toJSONList :: [CookieId] -> Value Source # toEncodingList :: [CookieId] -> Encoding Source #
Generic CookieId Source #
Instance details Defined in Wire.API.User.Auth Associated Types type Rep CookieId :: Type -> Type # Methods from :: CookieId -> Rep CookieId x # to :: Rep CookieId x -> CookieId #
Show CookieId Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> CookieId -> ShowS # show :: CookieId -> String # showList :: [CookieId] -> ShowS #
Cql CookieId Source #
Instance details Defined in Wire.API.User.Auth Methods ctype :: Tagged CookieId ColumnType Source # toCql :: CookieId -> Value Source # fromCql :: Value -> Either String CookieId Source #
Eq CookieId Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: CookieId -> CookieId -> Bool # (/=) :: CookieId -> CookieId -> Bool #
ToSchema CookieId Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc CookieId Source #
type Rep CookieId Source #
Instance details Defined in Wire.API.User.Auth type Rep CookieId = D1 ('MetaData "CookieId" "Wire.API.User.Auth" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "CookieId" 'PrefixI 'True) (S1 ('MetaSel ('Just "cookieIdNum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

data CookieType Source #

Constructors

SessionCookie	A session cookie. These are mainly intended for clients that are web browsers. For other clients, session cookies behave like regular persistent cookies except for the fact that they are never renewed during a token refresh and that they have a shorter lifetime.
PersistentCookie	A regular persistent cookie that expires at a specific date. These cookies are regularly renewed as part of an access token refresh.

Instances

Instances details

Arbitrary CookieType Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen CookieType Source # shrink :: CookieType -> [CookieType] Source #
FromJSON CookieType Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser CookieType Source # parseJSONList :: Value -> Parser [CookieType] Source #
ToJSON CookieType Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: CookieType -> Value Source # toEncoding :: CookieType -> Encoding Source # toJSONList :: [CookieType] -> Value Source # toEncodingList :: [CookieType] -> Encoding Source #
Generic CookieType Source #
Instance details Defined in Wire.API.User.Auth Associated Types type Rep CookieType :: Type -> Type # Methods from :: CookieType -> Rep CookieType x # to :: Rep CookieType x -> CookieType #
Show CookieType Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> CookieType -> ShowS # show :: CookieType -> String # showList :: [CookieType] -> ShowS #
Cql CookieType Source #
Instance details Defined in Wire.API.User.Auth Methods ctype :: Tagged CookieType ColumnType Source # toCql :: CookieType -> Value Source # fromCql :: Value -> Either String CookieType Source #
Eq CookieType Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: CookieType -> CookieType -> Bool # (/=) :: CookieType -> CookieType -> Bool #
ToSchema CookieType Source #
Instance details Defined in Wire.API.User.Auth Methods declareNamedSchema :: Proxy CookieType -> Declare (Definitions Schema) NamedSchema Source #
ToSchema CookieType Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc CookieType Source #
type Rep CookieType Source #
Instance details Defined in Wire.API.User.Auth type Rep CookieType = D1 ('MetaData "CookieType" "Wire.API.User.Auth" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "SessionCookie" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PersistentCookie" 'PrefixI 'False) (U1 :: Type -> Type))

data Cookie a Source #

A (long-lived) cookie scoped to a specific user for obtaining new AccessTokens.

Constructors

Cookie
Fields cookieId :: CookieId cookieType :: CookieType cookieCreated :: UTCTime cookieExpires :: UTCTime cookieLabel :: Maybe CookieLabel cookieSucc :: Maybe CookieId cookieValue :: a

Instances

newtype CookieLabel Source #

A device-specific identifying label for one or more cookies. Cookies can be listed and deleted based on their labels.

Constructors

CookieLabel
Fields cookieLabelText :: Text

Instances

Instances details

Arbitrary CookieLabel Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen CookieLabel Source # shrink :: CookieLabel -> [CookieLabel] Source #
FromJSON CookieLabel Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser CookieLabel Source # parseJSONList :: Value -> Parser [CookieLabel] Source #
ToJSON CookieLabel Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: CookieLabel -> Value Source # toEncoding :: CookieLabel -> Encoding Source # toJSONList :: [CookieLabel] -> Value Source # toEncodingList :: [CookieLabel] -> Encoding Source #
IsString CookieLabel Source #
Instance details Defined in Wire.API.User.Auth Methods fromString :: String -> CookieLabel #
Generic CookieLabel Source #
Instance details Defined in Wire.API.User.Auth Associated Types type Rep CookieLabel :: Type -> Type # Methods from :: CookieLabel -> Rep CookieLabel x # to :: Rep CookieLabel x -> CookieLabel #
Show CookieLabel Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> CookieLabel -> ShowS # show :: CookieLabel -> String # showList :: [CookieLabel] -> ShowS #
FromByteString CookieLabel Source #
Instance details Defined in Wire.API.User.Auth Methods parser :: Parser CookieLabel Source #
ToByteString CookieLabel Source #
Instance details Defined in Wire.API.User.Auth Methods builder :: CookieLabel -> Builder Source #
Cql CookieLabel Source #
Instance details Defined in Wire.API.User.Auth Methods ctype :: Tagged CookieLabel ColumnType Source # toCql :: CookieLabel -> Value Source # fromCql :: Value -> Either String CookieLabel Source #
Eq CookieLabel Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: CookieLabel -> CookieLabel -> Bool # (/=) :: CookieLabel -> CookieLabel -> Bool #
Ord CookieLabel Source #
Instance details Defined in Wire.API.User.Auth Methods compare :: CookieLabel -> CookieLabel -> Ordering # (<) :: CookieLabel -> CookieLabel -> Bool # (<=) :: CookieLabel -> CookieLabel -> Bool # (>) :: CookieLabel -> CookieLabel -> Bool # (>=) :: CookieLabel -> CookieLabel -> Bool # max :: CookieLabel -> CookieLabel -> CookieLabel # min :: CookieLabel -> CookieLabel -> CookieLabel #
ToSchema CookieLabel Source #
Instance details Defined in Wire.API.User.Auth Methods declareNamedSchema :: Proxy CookieLabel -> Declare (Definitions Schema) NamedSchema Source #
ToSchema CookieLabel Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc CookieLabel Source #
type Rep CookieLabel Source #
Instance details Defined in Wire.API.User.Auth type Rep CookieLabel = D1 ('MetaData "CookieLabel" "Wire.API.User.Auth" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "CookieLabel" 'PrefixI 'True) (S1 ('MetaSel ('Just "cookieLabelText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data RemoveCookies Source #

Constructors

RemoveCookies
Fields rmCookiesPassword :: PlainTextPassword6 rmCookiesLabels :: [CookieLabel] rmCookiesIdents :: [CookieId]

Instances

Instances details

Arbitrary RemoveCookies Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen RemoveCookies Source # shrink :: RemoveCookies -> [RemoveCookies] Source #
FromJSON RemoveCookies Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser RemoveCookies Source # parseJSONList :: Value -> Parser [RemoveCookies] Source #
ToJSON RemoveCookies Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: RemoveCookies -> Value Source # toEncoding :: RemoveCookies -> Encoding Source # toJSONList :: [RemoveCookies] -> Value Source # toEncodingList :: [RemoveCookies] -> Encoding Source #
Generic RemoveCookies Source #
Instance details Defined in Wire.API.User.Auth Associated Types type Rep RemoveCookies :: Type -> Type # Methods from :: RemoveCookies -> Rep RemoveCookies x # to :: Rep RemoveCookies x -> RemoveCookies #
Show RemoveCookies Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> RemoveCookies -> ShowS # show :: RemoveCookies -> String # showList :: [RemoveCookies] -> ShowS #
Eq RemoveCookies Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: RemoveCookies -> RemoveCookies -> Bool # (/=) :: RemoveCookies -> RemoveCookies -> Bool #
ToSchema RemoveCookies Source #
Instance details Defined in Wire.API.User.Auth Methods declareNamedSchema :: Proxy RemoveCookies -> Declare (Definitions Schema) NamedSchema Source #
ToSchema RemoveCookies Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc RemoveCookies Source #
type Rep RemoveCookies Source #
Instance details Defined in Wire.API.User.Auth type Rep RemoveCookies = D1 ('MetaData "RemoveCookies" "Wire.API.User.Auth" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "RemoveCookies" 'PrefixI 'True) (S1 ('MetaSel ('Just "rmCookiesPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PlainTextPassword6) :: (S1 ('MetaSel ('Just "rmCookiesLabels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CookieLabel]) :: S1 ('MetaSel ('Just "rmCookiesIdents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CookieId]))))

toUnitCookie :: Cookie a -> Cookie () Source #

Token

data AccessToken Source #

A temporary API access token.

Constructors

AccessToken
Fields user :: UserId access :: LByteString FUTUREWORK: must be valid UTF-8 (see ToJSON), encode that in the type! tokenType :: TokenType expiresIn :: Integer

Instances

Instances details

Arbitrary AccessToken Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen AccessToken Source # shrink :: AccessToken -> [AccessToken] Source #
FromJSON AccessToken Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser AccessToken Source # parseJSONList :: Value -> Parser [AccessToken] Source #
ToJSON AccessToken Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: AccessToken -> Value Source # toEncoding :: AccessToken -> Encoding Source # toJSONList :: [AccessToken] -> Value Source # toEncodingList :: [AccessToken] -> Encoding Source #
Generic AccessToken Source #
Instance details Defined in Wire.API.User.Auth Associated Types type Rep AccessToken :: Type -> Type # Methods from :: AccessToken -> Rep AccessToken x # to :: Rep AccessToken x -> AccessToken #
Show AccessToken Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> AccessToken -> ShowS # show :: AccessToken -> String # showList :: [AccessToken] -> ShowS #
Eq AccessToken Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: AccessToken -> AccessToken -> Bool # (/=) :: AccessToken -> AccessToken -> Bool #
ToSchema AccessToken Source #
Instance details Defined in Wire.API.User.Auth Methods declareNamedSchema :: Proxy AccessToken -> Declare (Definitions Schema) NamedSchema Source #
ToSchema AccessToken Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc AccessToken Source #
AsHeaders '[Maybe UserTokenCookie] AccessToken SomeAccess Source #
Instance details Defined in Wire.API.User.Auth Methods fromHeaders :: (NP I '[Maybe UserTokenCookie], AccessToken) -> SomeAccess Source # toHeaders :: SomeAccess -> (NP I '[Maybe UserTokenCookie], AccessToken) Source #
type Rep AccessToken Source #
Instance details Defined in Wire.API.User.Auth type Rep AccessToken = D1 ('MetaData "AccessToken" "Wire.API.User.Auth" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "AccessToken" 'PrefixI 'True) ((S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserId) :: S1 ('MetaSel ('Just "access") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LByteString)) :: (S1 ('MetaSel ('Just "tokenType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TokenType) :*: S1 ('MetaSel ('Just "expiresIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))))

bearerToken :: UserId -> LByteString -> Integer -> AccessToken Source #

data TokenType Source #

Constructors

Bearer

Instances

Instances details

Arbitrary TokenType Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen TokenType Source # shrink :: TokenType -> [TokenType] Source #
FromJSON TokenType Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser TokenType Source # parseJSONList :: Value -> Parser [TokenType] Source #
ToJSON TokenType Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: TokenType -> Value Source # toEncoding :: TokenType -> Encoding Source # toJSONList :: [TokenType] -> Value Source # toEncodingList :: [TokenType] -> Encoding Source #
Generic TokenType Source #
Instance details Defined in Wire.API.User.Auth Associated Types type Rep TokenType :: Type -> Type # Methods from :: TokenType -> Rep TokenType x # to :: Rep TokenType x -> TokenType #
Show TokenType Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> TokenType -> ShowS # show :: TokenType -> String # showList :: [TokenType] -> ShowS #
Eq TokenType Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: TokenType -> TokenType -> Bool # (/=) :: TokenType -> TokenType -> Bool #
ToSchema TokenType Source #
Instance details Defined in Wire.API.User.Auth Methods declareNamedSchema :: Proxy TokenType -> Declare (Definitions Schema) NamedSchema Source #
ToSchema TokenType Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc TokenType Source #
type Rep TokenType Source #
Instance details Defined in Wire.API.User.Auth type Rep TokenType = D1 ('MetaData "TokenType" "Wire.API.User.Auth" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "Bearer" 'PrefixI 'False) (U1 :: Type -> Type))

data SomeUserToken Source #

Constructors

PlainUserToken (Token User)
LHUserToken (Token LegalHoldUser)

Instances

Instances details

Show SomeUserToken Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> SomeUserToken -> ShowS # show :: SomeUserToken -> String # showList :: [SomeUserToken] -> ShowS #
FromByteString SomeUserToken Source #
Instance details Defined in Wire.API.User.Auth Methods parser :: Parser SomeUserToken Source #
ToByteString SomeUserToken Source #
Instance details Defined in Wire.API.User.Auth Methods builder :: SomeUserToken -> Builder Source #
FromHttpApiData SomeUserToken Source #
Instance details Defined in Wire.API.User.Auth Methods parseUrlPiece :: Text -> Either Text SomeUserToken Source # parseHeader :: ByteString -> Either Text SomeUserToken Source # parseQueryParam :: Text -> Either Text SomeUserToken Source #

data SomeAccessToken Source #

Constructors

PlainAccessToken (Token Access)
LHAccessToken (Token LegalHoldAccess)

Instances

Instances details

Show SomeAccessToken Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> SomeAccessToken -> ShowS # show :: SomeAccessToken -> String # showList :: [SomeAccessToken] -> ShowS #
FromHttpApiData SomeAccessToken Source #
Instance details Defined in Wire.API.User.Auth Methods parseUrlPiece :: Text -> Either Text SomeAccessToken Source # parseHeader :: ByteString -> Either Text SomeAccessToken Source # parseQueryParam :: Text -> Either Text SomeAccessToken Source #

data UserTokenCookie Source #

Data that is returned to the client in the form of a cookie containing a user token.

Constructors

UserTokenCookie
Fields utcExpires :: Maybe UTCTime utcToken :: SomeUserToken utcSecure :: Bool

Instances

Instances details

FromHttpApiData UserTokenCookie Source #
Instance details Defined in Wire.API.User.Auth Methods parseUrlPiece :: Text -> Either Text UserTokenCookie Source # parseHeader :: ByteString -> Either Text UserTokenCookie Source # parseQueryParam :: Text -> Either Text UserTokenCookie Source #
ToHttpApiData UserTokenCookie Source #
Instance details Defined in Wire.API.User.Auth Methods toUrlPiece :: UserTokenCookie -> Text Source # toEncodedUrlPiece :: UserTokenCookie -> Builder Source # toHeader :: UserTokenCookie -> ByteString Source # toQueryParam :: UserTokenCookie -> Text Source # toEncodedQueryParam :: UserTokenCookie -> Builder Source #
ToParamSchema UserTokenCookie Source #
Instance details Defined in Wire.API.User.Auth Methods toParamSchema :: Proxy UserTokenCookie -> Schema Source #
AsHeaders '[Maybe UserTokenCookie] AccessToken SomeAccess Source #
Instance details Defined in Wire.API.User.Auth Methods fromHeaders :: (NP I '[Maybe UserTokenCookie], AccessToken) -> SomeAccess Source # toHeaders :: SomeAccess -> (NP I '[Maybe UserTokenCookie], AccessToken) Source #

data ProviderToken Source #

Constructors

ProviderToken (Token Provider)

Instances

Instances details

Show ProviderToken Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> ProviderToken -> ShowS # show :: ProviderToken -> String # showList :: [ProviderToken] -> ShowS #
FromByteString ProviderToken Source #
Instance details Defined in Wire.API.User.Auth Methods parser :: Parser ProviderToken Source #

data ProviderTokenCookie Source #

Constructors

ProviderTokenCookie
Fields ptcToken :: ProviderToken ptcSecure :: Bool

Instances

Instances details

FromHttpApiData ProviderTokenCookie Source #
Instance details Defined in Wire.API.User.Auth Methods parseUrlPiece :: Text -> Either Text ProviderTokenCookie Source # parseHeader :: ByteString -> Either Text ProviderTokenCookie Source # parseQueryParam :: Text -> Either Text ProviderTokenCookie Source #
ToHttpApiData ProviderTokenCookie Source #
Instance details Defined in Wire.API.User.Auth Methods toUrlPiece :: ProviderTokenCookie -> Text Source # toEncodedUrlPiece :: ProviderTokenCookie -> Builder Source # toHeader :: ProviderTokenCookie -> ByteString Source # toQueryParam :: ProviderTokenCookie -> Text Source # toEncodedQueryParam :: ProviderTokenCookie -> Builder Source #
ToParamSchema ProviderTokenCookie Source #
Instance details Defined in Wire.API.User.Auth Methods toParamSchema :: Proxy ProviderTokenCookie -> Schema Source #

Access

data AccessWithCookie c Source #

Constructors

Access
Fields accessToken :: !AccessToken accessCookie :: !(Maybe c)

Instances

Instances details

Foldable AccessWithCookie Source #
Instance details Defined in Wire.API.User.Auth Methods fold :: Monoid m => AccessWithCookie m -> m # foldMap :: Monoid m => (a -> m) -> AccessWithCookie a -> m # foldMap' :: Monoid m => (a -> m) -> AccessWithCookie a -> m # foldr :: (a -> b -> b) -> b -> AccessWithCookie a -> b # foldr' :: (a -> b -> b) -> b -> AccessWithCookie a -> b # foldl :: (b -> a -> b) -> b -> AccessWithCookie a -> b # foldl' :: (b -> a -> b) -> b -> AccessWithCookie a -> b # foldr1 :: (a -> a -> a) -> AccessWithCookie a -> a # foldl1 :: (a -> a -> a) -> AccessWithCookie a -> a # toList :: AccessWithCookie a -> [a] # null :: AccessWithCookie a -> Bool # length :: AccessWithCookie a -> Int # elem :: Eq a => a -> AccessWithCookie a -> Bool # maximum :: Ord a => AccessWithCookie a -> a # minimum :: Ord a => AccessWithCookie a -> a # sum :: Num a => AccessWithCookie a -> a # product :: Num a => AccessWithCookie a -> a #
Traversable AccessWithCookie Source #
Instance details Defined in Wire.API.User.Auth Methods traverse :: Applicative f => (a -> f b) -> AccessWithCookie a -> f (AccessWithCookie b) # sequenceA :: Applicative f => AccessWithCookie (f a) -> f (AccessWithCookie a) # mapM :: Monad m => (a -> m b) -> AccessWithCookie a -> m (AccessWithCookie b) # sequence :: Monad m => AccessWithCookie (m a) -> m (AccessWithCookie a) #
Functor AccessWithCookie Source #
Instance details Defined in Wire.API.User.Auth Methods fmap :: (a -> b) -> AccessWithCookie a -> AccessWithCookie b # (<$) :: a -> AccessWithCookie b -> AccessWithCookie a #
AsHeaders '[Maybe UserTokenCookie] AccessToken SomeAccess Source #
Instance details Defined in Wire.API.User.Auth Methods fromHeaders :: (NP I '[Maybe UserTokenCookie], AccessToken) -> SomeAccess Source # toHeaders :: SomeAccess -> (NP I '[Maybe UserTokenCookie], AccessToken) Source #

type Access u = AccessWithCookie (Cookie (Token u)) Source #

type SomeAccess = AccessWithCookie UserTokenCookie Source #

Servant

type TokenResponse = WithHeaders '[OptHeader (Header "Set-Cookie" UserTokenCookie)] SomeAccess (Respond 200 "OK" AccessToken) Source #

Arbitrary a => Arbitrary (Cookie a) Source #
Instance details Defined in Wire.API.User.Auth Methods arbitrary :: Gen (Cookie a) Source # shrink :: Cookie a -> [Cookie a] Source #
FromJSON (Cookie ()) Source #
Instance details Defined in Wire.API.User.Auth Methods parseJSON :: Value -> Parser (Cookie ()) Source # parseJSONList :: Value -> Parser [Cookie ()] Source #
ToJSON (Cookie ()) Source #
Instance details Defined in Wire.API.User.Auth Methods toJSON :: Cookie () -> Value Source # toEncoding :: Cookie () -> Encoding Source # toJSONList :: [Cookie ()] -> Value Source # toEncodingList :: [Cookie ()] -> Encoding Source #
Generic (Cookie a) Source #
Instance details Defined in Wire.API.User.Auth Associated Types type Rep (Cookie a) :: Type -> Type # Methods from :: Cookie a -> Rep (Cookie a) x # to :: Rep (Cookie a) x -> Cookie a #
Show a => Show (Cookie a) Source #
Instance details Defined in Wire.API.User.Auth Methods showsPrec :: Int -> Cookie a -> ShowS # show :: Cookie a -> String # showList :: [Cookie a] -> ShowS #
Eq a => Eq (Cookie a) Source #
Instance details Defined in Wire.API.User.Auth Methods (==) :: Cookie a -> Cookie a -> Bool # (/=) :: Cookie a -> Cookie a -> Bool #
ToSchema (Cookie ()) Source #
Instance details Defined in Wire.API.User.Auth Methods declareNamedSchema :: Proxy (Cookie ()) -> Declare (Definitions Schema) NamedSchema Source #
ToSchema (Cookie ()) Source #
Instance details Defined in Wire.API.User.Auth Methods schema :: ValueSchema NamedSwaggerDoc (Cookie ()) Source #
type Rep (Cookie a) Source #
Instance details Defined in Wire.API.User.Auth type Rep (Cookie a) = D1 ('MetaData "Cookie" "Wire.API.User.Auth" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "Cookie" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cookieId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CookieId) :: (S1 ('MetaSel ('Just "cookieType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CookieType) :: S1 ('MetaSel ('Just "cookieCreated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime))) :: ((S1 ('MetaSel ('Just "cookieExpires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "cookieLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CookieLabel))) :: (S1 ('MetaSel ('Just "cookieSucc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CookieId)) :: S1 ('MetaSel ('Just "cookieValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a)))))