wire-api-0.1.0
Safe HaskellSafe-Inferred
LanguageGHC2021

Wire.API.User.Password

Contents

Synopsis

Documentation

data NewPasswordReset Source #

The payload for initiating a password reset.

Constructors

NewPasswordReset EmailAddress 
NewPasswordResetUnsupportedPhone

Resetting via phone is not really supported anymore, but this is still here to support older versions of the endpoint.

Instances

Instances details
Arbitrary NewPasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

arbitrary :: Gen NewPasswordReset Source #

shrink :: NewPasswordReset -> [NewPasswordReset] Source #

FromJSON NewPasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

parseJSON :: Value -> Parser NewPasswordReset Source #

parseJSONList :: Value -> Parser [NewPasswordReset] Source #

ToJSON NewPasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

toJSON :: NewPasswordReset -> Value Source #

toEncoding :: NewPasswordReset -> Encoding Source #

toJSONList :: [NewPasswordReset] -> Value Source #

toEncodingList :: [NewPasswordReset] -> Encoding Source #

Generic NewPasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Associated Types

type Rep NewPasswordReset :: Type -> Type #

Methods

from :: NewPasswordReset -> Rep NewPasswordReset x #

to :: Rep NewPasswordReset x -> NewPasswordReset #

Show NewPasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

showsPrec :: Int -> NewPasswordReset -> ShowS #

show :: NewPasswordReset -> String #

showList :: [NewPasswordReset] -> ShowS #

Eq NewPasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

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

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

ToSchema NewPasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

declareNamedSchema :: Proxy NewPasswordReset -> Declare (Definitions Schema) NamedSchema Source #

ToSchema NewPasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

schema :: ValueSchema NamedSwaggerDoc NewPasswordReset Source #

type Rep NewPasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

type Rep NewPasswordReset = D1 ('MetaData "NewPasswordReset" "Wire.API.User.Password" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "NewPasswordReset" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EmailAddress)) :+: C1 ('MetaCons "NewPasswordResetUnsupportedPhone" 'PrefixI 'False) (U1 :: Type -> Type))

data CompletePasswordReset Source #

The payload for completing a password reset.

Constructors

CompletePasswordReset 

Fields

Instances

Instances details
Arbitrary CompletePasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

arbitrary :: Gen CompletePasswordReset Source #

shrink :: CompletePasswordReset -> [CompletePasswordReset] Source #

FromJSON CompletePasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

parseJSON :: Value -> Parser CompletePasswordReset Source #

parseJSONList :: Value -> Parser [CompletePasswordReset] Source #

ToJSON CompletePasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

toJSON :: CompletePasswordReset -> Value Source #

toEncoding :: CompletePasswordReset -> Encoding Source #

toJSONList :: [CompletePasswordReset] -> Value Source #

toEncodingList :: [CompletePasswordReset] -> Encoding Source #

Generic CompletePasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Associated Types

type Rep CompletePasswordReset :: Type -> Type #

Methods

from :: CompletePasswordReset -> Rep CompletePasswordReset x #

to :: Rep CompletePasswordReset x -> CompletePasswordReset #

Show CompletePasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

showsPrec :: Int -> CompletePasswordReset -> ShowS #

show :: CompletePasswordReset -> String #

showList :: [CompletePasswordReset] -> ShowS #

Eq CompletePasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

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

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

ToSchema CompletePasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

declareNamedSchema :: Proxy CompletePasswordReset -> Declare (Definitions Schema) NamedSchema Source #

ToSchema CompletePasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

schema :: ValueSchema NamedSwaggerDoc CompletePasswordReset Source #

type Rep CompletePasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

type Rep CompletePasswordReset = D1 ('MetaData "CompletePasswordReset" "Wire.API.User.Password" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "CompletePasswordReset" 'PrefixI 'True) (S1 ('MetaSel ('Just "cpwrIdent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PasswordResetIdentity) :*: (S1 ('MetaSel ('Just "cpwrCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PasswordResetCode) :*: S1 ('MetaSel ('Just "cpwrPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PlainTextPassword8))))

data PasswordResetIdentity Source #

The target identity of a password reset.

Constructors

PasswordResetIdentityKey PasswordResetKey

An opaque identity key for a pending password reset.

PasswordResetEmailIdentity EmailAddress

A known email address with a pending password reset.

PasswordResetPhoneIdentity Phone

A known phone number with a pending password reset.

Instances

Instances details
Arbitrary PasswordResetIdentity Source # 
Instance details

Defined in Wire.API.User.Password

Methods

arbitrary :: Gen PasswordResetIdentity Source #

shrink :: PasswordResetIdentity -> [PasswordResetIdentity] Source #

Generic PasswordResetIdentity Source # 
Instance details

Defined in Wire.API.User.Password

Associated Types

type Rep PasswordResetIdentity :: Type -> Type #

Methods

from :: PasswordResetIdentity -> Rep PasswordResetIdentity x #

to :: Rep PasswordResetIdentity x -> PasswordResetIdentity #

Show PasswordResetIdentity Source # 
Instance details

Defined in Wire.API.User.Password

Methods

showsPrec :: Int -> PasswordResetIdentity -> ShowS #

show :: PasswordResetIdentity -> String #

showList :: [PasswordResetIdentity] -> ShowS #

Eq PasswordResetIdentity Source # 
Instance details

Defined in Wire.API.User.Password

Methods

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

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

type Rep PasswordResetIdentity Source # 
Instance details

Defined in Wire.API.User.Password

type Rep PasswordResetIdentity = D1 ('MetaData "PasswordResetIdentity" "Wire.API.User.Password" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "PasswordResetIdentityKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PasswordResetKey)) :+: (C1 ('MetaCons "PasswordResetEmailIdentity" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EmailAddress)) :+: C1 ('MetaCons "PasswordResetPhoneIdentity" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Phone))))

newtype PasswordResetKey Source #

Opaque identifier per user (SHA256 of the user ID).

Constructors

PasswordResetKey 

Fields

Instances

Instances details
Arbitrary PasswordResetKey Source # 
Instance details

Defined in Wire.API.User.Password

Methods

arbitrary :: Gen PasswordResetKey Source #

shrink :: PasswordResetKey -> [PasswordResetKey] Source #

FromJSON PasswordResetKey Source # 
Instance details

Defined in Wire.API.User.Password

Methods

parseJSON :: Value -> Parser PasswordResetKey Source #

parseJSONList :: Value -> Parser [PasswordResetKey] Source #

ToJSON PasswordResetKey Source # 
Instance details

Defined in Wire.API.User.Password

Methods

toJSON :: PasswordResetKey -> Value Source #

toEncoding :: PasswordResetKey -> Encoding Source #

toJSONList :: [PasswordResetKey] -> Value Source #

toEncodingList :: [PasswordResetKey] -> Encoding Source #

Show PasswordResetKey Source # 
Instance details

Defined in Wire.API.User.Password

Methods

showsPrec :: Int -> PasswordResetKey -> ShowS #

show :: PasswordResetKey -> String #

showList :: [PasswordResetKey] -> ShowS #

FromByteString PasswordResetKey Source # 
Instance details

Defined in Wire.API.User.Password

Methods

parser :: Parser PasswordResetKey Source #

ToByteString PasswordResetKey Source # 
Instance details

Defined in Wire.API.User.Password

Methods

builder :: PasswordResetKey -> Builder Source #

Cql PasswordResetKey Source # 
Instance details

Defined in Wire.API.User.Password

Methods

ctype :: Tagged PasswordResetKey ColumnType Source #

toCql :: PasswordResetKey -> Value Source #

fromCql :: Value -> Either String PasswordResetKey Source #

Eq PasswordResetKey Source # 
Instance details

Defined in Wire.API.User.Password

Methods

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

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

Ord PasswordResetKey Source # 
Instance details

Defined in Wire.API.User.Password

Methods

compare :: PasswordResetKey -> PasswordResetKey -> Ordering #

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

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

(>) :: PasswordResetKey -> PasswordResetKey -> Bool #

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

max :: PasswordResetKey -> PasswordResetKey -> PasswordResetKey #

min :: PasswordResetKey -> PasswordResetKey -> PasswordResetKey #

FromHttpApiData PasswordResetKey Source # 
Instance details

Defined in Wire.API.User.Password

Methods

parseUrlPiece :: Text -> Either Text PasswordResetKey Source #

parseHeader :: ByteString -> Either Text PasswordResetKey Source #

parseQueryParam :: Text -> Either Text PasswordResetKey Source #

ToParamSchema PasswordResetKey Source # 
Instance details

Defined in Wire.API.User.Password

Methods

toParamSchema :: Proxy PasswordResetKey -> Schema Source #

ToSchema PasswordResetKey Source # 
Instance details

Defined in Wire.API.User.Password

Methods

schema :: ValueSchema NamedSwaggerDoc PasswordResetKey Source #

mkPasswordResetKey :: UserId -> PasswordResetKey Source #

newtype PasswordResetCode Source #

Random code, acting as a very short-lived, single-use password.

Constructors

PasswordResetCode 

Fields

Instances

Instances details
Arbitrary PasswordResetCode Source # 
Instance details

Defined in Wire.API.User.Password

Methods

arbitrary :: Gen PasswordResetCode Source #

shrink :: PasswordResetCode -> [PasswordResetCode] Source #

FromJSON PasswordResetCode Source # 
Instance details

Defined in Wire.API.User.Password

Methods

parseJSON :: Value -> Parser PasswordResetCode Source #

parseJSONList :: Value -> Parser [PasswordResetCode] Source #

ToJSON PasswordResetCode Source # 
Instance details

Defined in Wire.API.User.Password

Methods

toJSON :: PasswordResetCode -> Value Source #

toEncoding :: PasswordResetCode -> Encoding Source #

toJSONList :: [PasswordResetCode] -> Value Source #

toEncodingList :: [PasswordResetCode] -> Encoding Source #

Generic PasswordResetCode Source # 
Instance details

Defined in Wire.API.User.Password

Associated Types

type Rep PasswordResetCode :: Type -> Type #

Methods

from :: PasswordResetCode -> Rep PasswordResetCode x #

to :: Rep PasswordResetCode x -> PasswordResetCode #

Show PasswordResetCode Source # 
Instance details

Defined in Wire.API.User.Password

Methods

showsPrec :: Int -> PasswordResetCode -> ShowS #

show :: PasswordResetCode -> String #

showList :: [PasswordResetCode] -> ShowS #

FromByteString PasswordResetCode Source # 
Instance details

Defined in Wire.API.User.Password

Methods

parser :: Parser PasswordResetCode Source #

ToByteString PasswordResetCode Source # 
Instance details

Defined in Wire.API.User.Password

Methods

builder :: PasswordResetCode -> Builder Source #

Cql PasswordResetCode Source # 
Instance details

Defined in Wire.API.User.Password

Methods

ctype :: Tagged PasswordResetCode ColumnType Source #

toCql :: PasswordResetCode -> Value Source #

fromCql :: Value -> Either String PasswordResetCode Source #

Eq PasswordResetCode Source # 
Instance details

Defined in Wire.API.User.Password

Methods

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

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

ToSchema PasswordResetCode Source # 
Instance details

Defined in Wire.API.User.Password

Methods

schema :: ValueSchema NamedSwaggerDoc PasswordResetCode Source #

type Rep PasswordResetCode Source # 
Instance details

Defined in Wire.API.User.Password

type Rep PasswordResetCode = D1 ('MetaData "PasswordResetCode" "Wire.API.User.Password" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "PasswordResetCode" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPasswordResetCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AsciiBase64Url)))

deprecated

data PasswordReset Source #

Constructors

PasswordReset 

Fields

Instances

Instances details
Arbitrary PasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

arbitrary :: Gen PasswordReset Source #

shrink :: PasswordReset -> [PasswordReset] Source #

FromJSON PasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

parseJSON :: Value -> Parser PasswordReset Source #

parseJSONList :: Value -> Parser [PasswordReset] Source #

ToJSON PasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

toJSON :: PasswordReset -> Value Source #

toEncoding :: PasswordReset -> Encoding Source #

toJSONList :: [PasswordReset] -> Value Source #

toEncodingList :: [PasswordReset] -> Encoding Source #

Generic PasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Associated Types

type Rep PasswordReset :: Type -> Type #

Methods

from :: PasswordReset -> Rep PasswordReset x #

to :: Rep PasswordReset x -> PasswordReset #

Show PasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

showsPrec :: Int -> PasswordReset -> ShowS #

show :: PasswordReset -> String #

showList :: [PasswordReset] -> ShowS #

Eq PasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

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

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

ToSchema PasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

declareNamedSchema :: Proxy PasswordReset -> Declare (Definitions Schema) NamedSchema Source #

ToSchema PasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

Methods

schema :: ValueSchema NamedSwaggerDoc PasswordReset Source #

type Rep PasswordReset Source # 
Instance details

Defined in Wire.API.User.Password

type Rep PasswordReset = D1 ('MetaData "PasswordReset" "Wire.API.User.Password" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "PasswordReset" 'PrefixI 'True) (S1 ('MetaSel ('Just "pwrCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PasswordResetCode) :*: S1 ('MetaSel ('Just "pwrPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PlainTextPassword8)))