Safe Haskell	None
Language	Haskell2010

Network.Matrix.Identity

Contents

Client
API
User data
Association lookup

Description

This module contains the Identity service API https://matrix.org/docs/spec/identity_service/r0.3.0.html

Synopsis

data IdentitySession
newtype MatrixToken = MatrixToken Text
getTokenFromEnv :: Text -> IO MatrixToken
createIdentitySession :: Text -> MatrixToken -> IO IdentitySession
type MatrixIO a = IO (Either MatrixError a)
data MatrixError = MatrixError {
- meErrcode :: Text
- meError :: Text
- meRetryAfterMS :: Maybe Int
}
retry :: MatrixIO a -> MatrixIO a
newtype UserID = UserID Text
getIdentityTokenOwner :: IdentitySession -> MatrixIO UserID
data HashDetails = HashDetails {
- hdAlgorithms :: NonEmpty Text
- hdPepper :: Text
}
hashDetails :: IdentitySession -> MatrixIO HashDetails
data Identity
- = Email Text
- | Msisdn Text
identityLookup :: IdentitySession -> HashDetails -> Identity -> MatrixIO (Maybe UserID)
data HashedAddress
data IdentityLookupRequest
data IdentityLookupResponse
identitiesLookup :: IdentitySession -> IdentityLookupRequest -> MatrixIO IdentityLookupResponse
mkIdentityLookupRequest :: HashDetails -> [HashedAddress] -> IdentityLookupRequest
toHashedAddress :: HashDetails -> Identity -> HashedAddress
lookupIdentity :: HashedAddress -> IdentityLookupResponse -> Maybe UserID

Client

data IdentitySession Source #

The session record, use createSession to create it.

newtype MatrixToken Source #

Constructors

MatrixToken Text

getTokenFromEnv Source #

Arguments

:: Text	The envirnoment variable name
-> IO MatrixToken

createIdentitySession Source #

Arguments

:: Text	The matrix identity base url, e.g. "https://matrix.org"
-> MatrixToken	The user identity token
-> IO IdentitySession

createSession creates the session record.

API

type MatrixIO a = IO (Either MatrixError a) Source #

MatrixIO is a convenient type alias for server response

data MatrixError Source #

Constructors

MatrixError
Fields meErrcode :: Text meError :: Text meRetryAfterMS :: Maybe Int

Instances

Instances details

Eq MatrixError Source #
Instance details Defined in Network.Matrix.Internal Methods (==) :: MatrixError -> MatrixError -> Bool # (/=) :: MatrixError -> MatrixError -> Bool #
Show MatrixError Source #
Instance details Defined in Network.Matrix.Internal Methods showsPrec :: Int -> MatrixError -> ShowS # show :: MatrixError -> String # showList :: [MatrixError] -> ShowS #
FromJSON MatrixError Source #
Instance details Defined in Network.Matrix.Internal Methods parseJSON :: Value -> Parser MatrixError # parseJSONList :: Value -> Parser [MatrixError] #

retry :: MatrixIO a -> MatrixIO a Source #

User data

newtype UserID Source #

Constructors

UserID Text

Instances

Instances details

Eq UserID Source #
Instance details Defined in Network.Matrix.Internal Methods (==) :: UserID -> UserID -> Bool # (/=) :: UserID -> UserID -> Bool #
Show UserID Source #
Instance details Defined in Network.Matrix.Internal Methods showsPrec :: Int -> UserID -> ShowS # show :: UserID -> String # showList :: [UserID] -> ShowS #
FromJSON UserID Source #
Instance details Defined in Network.Matrix.Internal Methods parseJSON :: Value -> Parser UserID # parseJSONList :: Value -> Parser [UserID] #

getIdentityTokenOwner :: IdentitySession -> MatrixIO UserID Source #

getIdentityTokenOwner gets information about the owner of a given access token.

Association lookup

data HashDetails Source #

Constructors

HashDetails
Fields hdAlgorithms :: NonEmpty Text hdPepper :: Text

Instances

Instances details

Eq HashDetails Source #
Instance details Defined in Network.Matrix.Identity Methods (==) :: HashDetails -> HashDetails -> Bool # (/=) :: HashDetails -> HashDetails -> Bool #
Show HashDetails Source #
Instance details Defined in Network.Matrix.Identity Methods showsPrec :: Int -> HashDetails -> ShowS # show :: HashDetails -> String # showList :: [HashDetails] -> ShowS #
FromJSON HashDetails Source #
Instance details Defined in Network.Matrix.Identity Methods parseJSON :: Value -> Parser HashDetails # parseJSONList :: Value -> Parser [HashDetails] #

hashDetails :: IdentitySession -> MatrixIO HashDetails Source #

data Identity Source #

Constructors

Email Text
Msisdn Text

Instances

Instances details

Eq Identity Source #
Instance details Defined in Network.Matrix.Identity Methods (==) :: Identity -> Identity -> Bool # (/=) :: Identity -> Identity -> Bool #
Show Identity Source #
Instance details Defined in Network.Matrix.Identity Methods showsPrec :: Int -> Identity -> ShowS # show :: Identity -> String # showList :: [Identity] -> ShowS #

identityLookup :: IdentitySession -> HashDetails -> Identity -> MatrixIO (Maybe UserID) Source #

Use identityLookup to lookup a single identity, otherwise uses the full identitiesLookup.

data HashedAddress Source #

Instances

Instances details

Eq HashedAddress Source #
Instance details Defined in Network.Matrix.Identity Methods (==) :: HashedAddress -> HashedAddress -> Bool # (/=) :: HashedAddress -> HashedAddress -> Bool #
Show HashedAddress Source #
Instance details Defined in Network.Matrix.Identity Methods showsPrec :: Int -> HashedAddress -> ShowS # show :: HashedAddress -> String # showList :: [HashedAddress] -> ShowS #

data IdentityLookupRequest Source #

Instances

Instances details

Eq IdentityLookupRequest Source #
Instance details Defined in Network.Matrix.Identity Methods (==) :: IdentityLookupRequest -> IdentityLookupRequest -> Bool # (/=) :: IdentityLookupRequest -> IdentityLookupRequest -> Bool #
Show IdentityLookupRequest Source #
Instance details Defined in Network.Matrix.Identity Methods showsPrec :: Int -> IdentityLookupRequest -> ShowS # show :: IdentityLookupRequest -> String # showList :: [IdentityLookupRequest] -> ShowS #

data IdentityLookupResponse Source #

A newtype wrapper to decoded nested list

>>> decode "{\"mappings\": {\"hash\": \"user\"}}" :: Maybe IdentityLookupResponse
Just (IdentityLookupResponse [(HashedAddress "hash",UserID "user")])

Instances

Instances details

Show IdentityLookupResponse Source #
Instance details Defined in Network.Matrix.Identity Methods showsPrec :: Int -> IdentityLookupResponse -> ShowS # show :: IdentityLookupResponse -> String # showList :: [IdentityLookupResponse] -> ShowS #
FromJSON IdentityLookupResponse Source #
Instance details Defined in Network.Matrix.Identity Methods parseJSON :: Value -> Parser IdentityLookupResponse # parseJSONList :: Value -> Parser [IdentityLookupResponse] #

identitiesLookup :: IdentitySession -> IdentityLookupRequest -> MatrixIO IdentityLookupResponse Source #

mkIdentityLookupRequest :: HashDetails -> [HashedAddress] -> IdentityLookupRequest Source #

toHashedAddress :: HashDetails -> Identity -> HashedAddress Source #

lookupIdentity :: HashedAddress -> IdentityLookupResponse -> Maybe UserID Source #