wire-api-0.1.0
Safe HaskellSafe-Inferred
LanguageGHC2021

Wire.API.User.IdentityProvider

Synopsis

Documentation

type IdP = IdPConfig WireIdP Source #

The identity provider type used in Spar.

newtype IdPHandle Source #

Constructors

IdPHandle 

Fields

Instances

Instances details
Arbitrary IdPHandle Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

arbitrary :: Gen IdPHandle Source #

shrink :: IdPHandle -> [IdPHandle] Source #

FromJSON IdPHandle Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

parseJSON :: Value -> Parser IdPHandle Source #

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

ToJSON IdPHandle Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

toJSON :: IdPHandle -> Value Source #

toEncoding :: IdPHandle -> Encoding Source #

toJSONList :: [IdPHandle] -> Value Source #

toEncodingList :: [IdPHandle] -> Encoding Source #

Generic IdPHandle Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Associated Types

type Rep IdPHandle :: Type -> Type #

Methods

from :: IdPHandle -> Rep IdPHandle x #

to :: Rep IdPHandle x -> IdPHandle #

Show IdPHandle Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

showsPrec :: Int -> IdPHandle -> ShowS #

show :: IdPHandle -> String #

showList :: [IdPHandle] -> ShowS #

Eq IdPHandle Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

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

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

Ord IdPHandle Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

compare :: IdPHandle -> IdPHandle -> Ordering #

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

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

(>) :: IdPHandle -> IdPHandle -> Bool #

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

max :: IdPHandle -> IdPHandle -> IdPHandle #

min :: IdPHandle -> IdPHandle -> IdPHandle #

ToSchema IdPHandle Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

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

type Rep IdPHandle Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

type Rep IdPHandle = D1 ('MetaData "IdPHandle" "Wire.API.User.IdentityProvider" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "IdPHandle" 'PrefixI 'True) (S1 ('MetaSel ('Just "unIdPHandle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data WireIdP Source #

Constructors

WireIdP 

Fields

  • _team :: TeamId
     
  • _apiVersion :: Maybe WireIdPAPIVersion

    list of issuer names that this idp has replaced, most recent first. this is used for finding users that are still stored under the old issuer, see findUserWithOldIssuer, moveUserToNewIssuer.

  • _oldIssuers :: [Issuer]
     
  • _replacedBy :: Maybe IdPId

    the issuer that has replaced this one. this is set iff a new issuer is created with the "replaces" query parameter, and it is used to decide whether users not existing on this IdP can be auto-provisioned (if isJust, they can't).

  • _handle :: IdPHandle
     

Instances

Instances details
FromJSON WireIdP Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

parseJSON :: Value -> Parser WireIdP Source #

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

ToJSON WireIdP Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

toJSON :: WireIdP -> Value Source #

toEncoding :: WireIdP -> Encoding Source #

toJSONList :: [WireIdP] -> Value Source #

toEncodingList :: [WireIdP] -> Encoding Source #

Generic WireIdP Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Associated Types

type Rep WireIdP :: Type -> Type #

Methods

from :: WireIdP -> Rep WireIdP x #

to :: Rep WireIdP x -> WireIdP #

Show WireIdP Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

showsPrec :: Int -> WireIdP -> ShowS #

show :: WireIdP -> String #

showList :: [WireIdP] -> ShowS #

Eq WireIdP Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

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

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

ToSchema WireIdP Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

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

type Rep WireIdP Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

type Rep WireIdP = D1 ('MetaData "WireIdP" "Wire.API.User.IdentityProvider" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "WireIdP" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_team") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TeamId) :*: S1 ('MetaSel ('Just "_apiVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe WireIdPAPIVersion))) :*: (S1 ('MetaSel ('Just "_oldIssuers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Issuer]) :*: (S1 ('MetaSel ('Just "_replacedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe IdPId)) :*: S1 ('MetaSel ('Just "_handle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IdPHandle)))))

data WireIdPAPIVersion Source #

Constructors

WireIdPAPIV1

initial API

WireIdPAPIV2

support for different SP entityIDs per team

Instances

Instances details
Arbitrary WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

arbitrary :: Gen WireIdPAPIVersion Source #

shrink :: WireIdPAPIVersion -> [WireIdPAPIVersion] Source #

FromJSON WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

parseJSON :: Value -> Parser WireIdPAPIVersion Source #

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

ToJSON WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

toJSON :: WireIdPAPIVersion -> Value Source #

toEncoding :: WireIdPAPIVersion -> Encoding Source #

toJSONList :: [WireIdPAPIVersion] -> Value Source #

toEncodingList :: [WireIdPAPIVersion] -> Encoding Source #

Bounded WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

minBound :: WireIdPAPIVersion #

maxBound :: WireIdPAPIVersion #

Enum WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

succ :: WireIdPAPIVersion -> WireIdPAPIVersion #

pred :: WireIdPAPIVersion -> WireIdPAPIVersion #

toEnum :: Int -> WireIdPAPIVersion #

fromEnum :: WireIdPAPIVersion -> Int #

enumFrom :: WireIdPAPIVersion -> [WireIdPAPIVersion] #

enumFromThen :: WireIdPAPIVersion -> WireIdPAPIVersion -> [WireIdPAPIVersion] #

enumFromTo :: WireIdPAPIVersion -> WireIdPAPIVersion -> [WireIdPAPIVersion] #

enumFromThenTo :: WireIdPAPIVersion -> WireIdPAPIVersion -> WireIdPAPIVersion -> [WireIdPAPIVersion] #

Generic WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Associated Types

type Rep WireIdPAPIVersion :: Type -> Type #

Methods

from :: WireIdPAPIVersion -> Rep WireIdPAPIVersion x #

to :: Rep WireIdPAPIVersion x -> WireIdPAPIVersion #

Show WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

showsPrec :: Int -> WireIdPAPIVersion -> ShowS #

show :: WireIdPAPIVersion -> String #

showList :: [WireIdPAPIVersion] -> ShowS #

FromByteString WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

parser :: Parser WireIdPAPIVersion Source #

ToByteString WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

builder :: WireIdPAPIVersion -> Builder Source #

Cql WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

ctype :: Tagged WireIdPAPIVersion ColumnType Source #

toCql :: WireIdPAPIVersion -> Value Source #

fromCql :: Value -> Either String WireIdPAPIVersion Source #

Eq WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

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

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

FromHttpApiData WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

parseUrlPiece :: Text -> Either Text WireIdPAPIVersion Source #

parseHeader :: ByteString -> Either Text WireIdPAPIVersion Source #

parseQueryParam :: Text -> Either Text WireIdPAPIVersion Source #

ToHttpApiData WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

toUrlPiece :: WireIdPAPIVersion -> Text Source #

toEncodedUrlPiece :: WireIdPAPIVersion -> Builder Source #

toHeader :: WireIdPAPIVersion -> ByteString Source #

toQueryParam :: WireIdPAPIVersion -> Text Source #

toEncodedQueryParam :: WireIdPAPIVersion -> Builder Source #

ToParamSchema WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

toParamSchema :: Proxy WireIdPAPIVersion -> Schema Source #

ToSchema WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

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

type Rep WireIdPAPIVersion Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

type Rep WireIdPAPIVersion = D1 ('MetaData "WireIdPAPIVersion" "Wire.API.User.IdentityProvider" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "WireIdPAPIV1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WireIdPAPIV2" 'PrefixI 'False) (U1 :: Type -> Type))

defWireIdPAPIVersion :: WireIdPAPIVersion Source #

(Internal issue for making v2 the default: https://wearezeta.atlassian.net/browse/SQSERVICES-781. BEWARE: We probably shouldn't ever do this, but remove V1 entirely instead. which requires migrating away from the old table on all on-prem installations. which takes time.)

team :: Lens' WireIdP TeamId Source #

replacedBy :: Lens' WireIdP (Maybe IdPId) Source #

oldIssuers :: Lens' WireIdP [Issuer] Source #

handle :: Lens' WireIdP IdPHandle Source #

apiVersion :: Lens' WireIdP (Maybe WireIdPAPIVersion) Source #

newtype IdPList Source #

A list of IdPs, returned by some endpoints. Wrapped into an object to allow extensibility later on.

Constructors

IdPList 

Fields

Instances

Instances details
FromJSON IdPList Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

parseJSON :: Value -> Parser IdPList Source #

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

ToJSON IdPList Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

toJSON :: IdPList -> Value Source #

toEncoding :: IdPList -> Encoding Source #

toJSONList :: [IdPList] -> Value Source #

toEncodingList :: [IdPList] -> Encoding Source #

Generic IdPList Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Associated Types

type Rep IdPList :: Type -> Type #

Methods

from :: IdPList -> Rep IdPList x #

to :: Rep IdPList x -> IdPList #

Show IdPList Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

showsPrec :: Int -> IdPList -> ShowS #

show :: IdPList -> String #

showList :: [IdPList] -> ShowS #

Eq IdPList Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

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

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

ToSchema IdPList Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

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

type Rep IdPList Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

type Rep IdPList = D1 ('MetaData "IdPList" "Wire.API.User.IdentityProvider" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "IdPList" 'PrefixI 'True) (S1 ('MetaSel ('Just "providers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [IdP])))

data IdPMetadataInfo Source #

JSON-encoded information about metadata: {"value": xml}. (Here we could also implement {"uri": url, "cert": pinned_pubkey}. check both the certificate we get from the server against the pinned one and the metadata url in the metadata against the one we fetched the xml from, but it's unclear what the benefit would be.)

Constructors

IdPMetadataValue Text IdPMetadata 

Instances

Instances details
FromJSON IdPMetadataInfo Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

parseJSON :: Value -> Parser IdPMetadataInfo Source #

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

ToJSON IdPMetadataInfo Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

toJSON :: IdPMetadataInfo -> Value Source #

toEncoding :: IdPMetadataInfo -> Encoding Source #

toJSONList :: [IdPMetadataInfo] -> Value Source #

toEncodingList :: [IdPMetadataInfo] -> Encoding Source #

Generic IdPMetadataInfo Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Associated Types

type Rep IdPMetadataInfo :: Type -> Type #

Methods

from :: IdPMetadataInfo -> Rep IdPMetadataInfo x #

to :: Rep IdPMetadataInfo x -> IdPMetadataInfo #

Show IdPMetadataInfo Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

showsPrec :: Int -> IdPMetadataInfo -> ShowS #

show :: IdPMetadataInfo -> String #

showList :: [IdPMetadataInfo] -> ShowS #

Eq IdPMetadataInfo Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

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

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

ToSchema IdPMetadataInfo Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

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

MimeUnrender RawXML IdPMetadataInfo Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

mimeUnrender :: Proxy RawXML -> ByteString -> Either String IdPMetadataInfo Source #

mimeUnrenderWithType :: Proxy RawXML -> MediaType -> ByteString -> Either String IdPMetadataInfo Source #

type Rep IdPMetadataInfo Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

type Rep IdPMetadataInfo = D1 ('MetaData "IdPMetadataInfo" "Wire.API.User.IdentityProvider" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "IdPMetadataValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IdPMetadata)))

data RawXML Source #

We want to store the raw xml text from the registration request in the database for trouble shooting, but SAML.XML only gives us access to the xml tree, not the raw text. RawXML helps with that.

Instances

Instances details
Accept RawXML Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

contentType :: Proxy RawXML -> MediaType Source #

contentTypes :: Proxy RawXML -> NonEmpty MediaType Source #

MimeRender RawXML RawIdPMetadata Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

mimeRender :: Proxy RawXML -> RawIdPMetadata -> ByteString Source #

MimeUnrender RawXML IdPMetadataInfo Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

mimeUnrender :: Proxy RawXML -> ByteString -> Either String IdPMetadataInfo Source #

mimeUnrenderWithType :: Proxy RawXML -> MediaType -> ByteString -> Either String IdPMetadataInfo Source #

newtype RawIdPMetadata Source #

Constructors

RawIdPMetadata Text 

Instances

Instances details
Generic RawIdPMetadata Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Associated Types

type Rep RawIdPMetadata :: Type -> Type #

Methods

from :: RawIdPMetadata -> Rep RawIdPMetadata x #

to :: Rep RawIdPMetadata x -> RawIdPMetadata #

Show RawIdPMetadata Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

showsPrec :: Int -> RawIdPMetadata -> ShowS #

show :: RawIdPMetadata -> String #

showList :: [RawIdPMetadata] -> ShowS #

Eq RawIdPMetadata Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

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

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

ToSchema RawIdPMetadata Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

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

MimeRender RawXML RawIdPMetadata Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

Methods

mimeRender :: Proxy RawXML -> RawIdPMetadata -> ByteString Source #

type Rep RawIdPMetadata Source # 
Instance details

Defined in Wire.API.User.IdentityProvider

type Rep RawIdPMetadata = D1 ('MetaData "RawIdPMetadata" "Wire.API.User.IdentityProvider" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "RawIdPMetadata" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

idPMetadataToInfo :: IdPMetadata -> IdPMetadataInfo Source #