Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.User.Identity

Contents

UserIdentity
Phone
Email
UserSSOId

Synopsis

data UserIdentity
- = EmailIdentity EmailAddress
- | SSOIdentity UserSSOId (Maybe EmailAddress)
isSSOIdentity :: UserIdentity -> Bool
newIdentity :: Maybe EmailAddress -> Maybe UserSSOId -> Maybe UserIdentity
emailIdentity :: UserIdentity -> Maybe EmailAddress
ssoIdentity :: UserIdentity -> Maybe UserSSOId
userIdentityObjectSchema :: ObjectSchema SwaggerDoc UserIdentity
maybeUserIdentityObjectSchema :: ObjectSchema SwaggerDoc (Maybe UserIdentity)
maybeUserIdentityFromComponents :: UserIdentityComponents -> Maybe UserIdentity
newtype Phone = Phone {
- fromPhone :: Text
}
parsePhone :: Text -> Maybe Phone
isValidPhone :: Text -> Bool
module Wire.API.User.EmailAddress
data UserSSOId
- = UserSSOId UserRef
- | UserScimExternalId Text
mkSampleUref :: Text -> Text -> UserRef
mkSimpleSampleUref :: UserRef

UserIdentity

data UserIdentity Source #

The private unique user identity that is used for login and account recovery.

Constructors

EmailIdentity EmailAddress
SSOIdentity UserSSOId (Maybe EmailAddress)

Instances

Instances details

Arbitrary UserIdentity Source #
Instance details Defined in Wire.API.User.Identity Methods arbitrary :: Gen UserIdentity Source # shrink :: UserIdentity -> [UserIdentity] Source #
Generic UserIdentity Source #
Instance details Defined in Wire.API.User.Identity Associated Types type Rep UserIdentity :: Type -> Type # Methods from :: UserIdentity -> Rep UserIdentity x # to :: Rep UserIdentity x -> UserIdentity #
Show UserIdentity Source #
Instance details Defined in Wire.API.User.Identity Methods showsPrec :: Int -> UserIdentity -> ShowS # show :: UserIdentity -> String # showList :: [UserIdentity] -> ShowS #
Eq UserIdentity Source #
Instance details Defined in Wire.API.User.Identity Methods (==) :: UserIdentity -> UserIdentity -> Bool # (/=) :: UserIdentity -> UserIdentity -> Bool #
Ord UserIdentity Source #
Instance details Defined in Wire.API.User.Identity Methods compare :: UserIdentity -> UserIdentity -> Ordering # (<) :: UserIdentity -> UserIdentity -> Bool # (<=) :: UserIdentity -> UserIdentity -> Bool # (>) :: UserIdentity -> UserIdentity -> Bool # (>=) :: UserIdentity -> UserIdentity -> Bool # max :: UserIdentity -> UserIdentity -> UserIdentity # min :: UserIdentity -> UserIdentity -> UserIdentity #
type Rep UserIdentity Source #
Instance details Defined in Wire.API.User.Identity type Rep UserIdentity = D1 ('MetaData "UserIdentity" "Wire.API.User.Identity" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "EmailIdentity" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EmailAddress)) :+: C1 ('MetaCons "SSOIdentity" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserSSOId) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EmailAddress))))

isSSOIdentity :: UserIdentity -> Bool Source #

newIdentity :: Maybe EmailAddress -> Maybe UserSSOId -> Maybe UserIdentity Source #

emailIdentity :: UserIdentity -> Maybe EmailAddress Source #

ssoIdentity :: UserIdentity -> Maybe UserSSOId Source #

userIdentityObjectSchema :: ObjectSchema SwaggerDoc UserIdentity Source #

maybeUserIdentityObjectSchema :: ObjectSchema SwaggerDoc (Maybe UserIdentity) Source #

maybeUserIdentityFromComponents :: UserIdentityComponents -> Maybe UserIdentity Source #

Phone

newtype Phone Source #

Constructors

Phone
Fields fromPhone :: Text

Instances

Instances details

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

parsePhone :: Text -> Maybe Phone Source #

Parses a phone number in E.164 format with a mandatory leading +.

isValidPhone :: Text -> Bool Source #

Checks whether a phone number is valid, i.e. it is in E.164 format with a mandatory leading + followed by 10-15 digits.

Email

module Wire.API.User.EmailAddress

UserSSOId

data UserSSOId Source #

User's external identity.

NB: this type is serialized to the full xml encoding of the UserRef components, but deserialiation is more lenient: it also allows for the Issuer to be a plain URL (without xml around it), and the NameID to be an email address (=> format "email") or an arbitrary text (=> format "unspecified"). This is for backwards compatibility and general robustness.

FUTUREWORK: we should probably drop this entirely and store saml and scim data in separate database columns.

Constructors

UserSSOId UserRef
UserScimExternalId Text

Instances

Instances details

Arbitrary UserSSOId Source #
Instance details Defined in Wire.API.User.Identity Methods arbitrary :: Gen UserSSOId Source # shrink :: UserSSOId -> [UserSSOId] Source #
FromJSON UserSSOId Source #
Instance details Defined in Wire.API.User.Identity Methods parseJSON :: Value -> Parser UserSSOId Source # parseJSONList :: Value -> Parser [UserSSOId] Source #
ToJSON UserSSOId Source #
Instance details Defined in Wire.API.User.Identity Methods toJSON :: UserSSOId -> Value Source # toEncoding :: UserSSOId -> Encoding Source # toJSONList :: [UserSSOId] -> Value Source # toEncodingList :: [UserSSOId] -> Encoding Source #
Generic UserSSOId Source #
Instance details Defined in Wire.API.User.Identity Associated Types type Rep UserSSOId :: Type -> Type # Methods from :: UserSSOId -> Rep UserSSOId x # to :: Rep UserSSOId x -> UserSSOId #
Show UserSSOId Source #
Instance details Defined in Wire.API.User.Identity Methods showsPrec :: Int -> UserSSOId -> ShowS # show :: UserSSOId -> String # showList :: [UserSSOId] -> ShowS #
Cql UserSSOId Source #
Instance details Defined in Wire.API.User.Identity Methods ctype :: Tagged UserSSOId ColumnType Source # toCql :: UserSSOId -> Value Source # fromCql :: Value -> Either String UserSSOId Source #
Eq UserSSOId Source #
Instance details Defined in Wire.API.User.Identity Methods (==) :: UserSSOId -> UserSSOId -> Bool # (/=) :: UserSSOId -> UserSSOId -> Bool #
Ord UserSSOId Source #
Instance details Defined in Wire.API.User.Identity Methods compare :: UserSSOId -> UserSSOId -> Ordering # (<) :: UserSSOId -> UserSSOId -> Bool # (<=) :: UserSSOId -> UserSSOId -> Bool # (>) :: UserSSOId -> UserSSOId -> Bool # (>=) :: UserSSOId -> UserSSOId -> Bool # max :: UserSSOId -> UserSSOId -> UserSSOId # min :: UserSSOId -> UserSSOId -> UserSSOId #
ToSchema UserSSOId Source #	FUTUREWORK: This schema should ideally be a choice of either tenant+subject, or scim_external_id but this is currently not possible to derive in swagger2 Maybe this becomes possible with swagger 3?
Instance details Defined in Wire.API.User.Identity Methods declareNamedSchema :: Proxy UserSSOId -> Declare (Definitions Schema) NamedSchema Source #
type Rep UserSSOId Source #
Instance details Defined in Wire.API.User.Identity type Rep UserSSOId = D1 ('MetaData "UserSSOId" "Wire.API.User.Identity" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "UserSSOId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserRef)) :+: C1 ('MetaCons "UserScimExternalId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

mkSampleUref :: Text -> Text -> UserRef Source #

For testing. Create a sample UserRef value with random seeds to make Issuer and NameID unique. FUTUREWORK: move to saml2-web-sso.

mkSimpleSampleUref :: UserRef Source #

mkSampleUref "" ""