Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Routes.Public.Spar

Synopsis

type SparAPI = ("sso" :> APISSO) :<|> (("identity-providers" :> APIIDP) :<|> (("scim" :> APIScim) :<|> (OmitDocs :> InternalAPI)))
type DeprecateSSOAPIV1 = Description "DEPRECATED! use /sso/metadata/:tid instead! Details: https://docs.wire.com/understand/single-sign-on/trouble-shooting.html#can-i-use-the-same-sso-login-code-for-multiple-teams"
type APISSO = (DeprecateSSOAPIV1 :> (Deprecated :> ("metadata" :> APIMeta))) :<|> (("metadata" :> (Capture "team" TeamId :> APIMeta)) :<|> (("initiate-login" :> APIAuthReqPrecheck) :<|> (("initiate-login" :> APIAuthReq) :<|> (APIAuthRespLegacy :<|> (APIAuthResp :<|> ("settings" :> SsoSettingsGet))))))
type CheckOK = Verb 'HEAD 200
type APIAuthReqPrecheck = QueryParam "success_redirect" URI :> (QueryParam "error_redirect" URI :> (Capture "idp" IdPId :> CheckOK '[PlainText] NoContent))
type APIAuthReq = QueryParam "success_redirect" URI :> (QueryParam "error_redirect" URI :> (Capture "idp" IdPId :> Get '[HTML] (FormRedirect AuthnRequest)))
type APIAuthRespLegacy = DeprecateSSOAPIV1 :> (Deprecated :> ("finalize-login" :> (MultipartForm Mem AuthnResponseBody :> Post '[PlainText] Void)))
type APIAuthResp = "finalize-login" :> (Capture "team" TeamId :> (MultipartForm Mem AuthnResponseBody :> Post '[PlainText] Void))
type APIIDP = (ZOptUser :> IdpGet) :<|> ((ZOptUser :> IdpGetRaw) :<|> ((ZOptUser :> IdpGetAll) :<|> ((ZOptUser :> IdpCreate) :<|> ((ZOptUser :> IdpUpdate) :<|> (ZOptUser :> IdpDelete)))))
type IdpGetRaw = Capture "id" IdPId :> ("raw" :> Get '[RawXML] RawIdPMetadata)
type IdpGet = Capture "id" IdPId :> Get '[JSON] IdP
type IdpGetAll = Get '[JSON] IdPList
type IdpCreate = ReqBodyCustomError '[RawXML, JSON] "wai-error" IdPMetadataInfo :> (QueryParam' '[Optional, Strict] "replaces" IdPId :> (QueryParam' '[Optional, Strict] "api_version" WireIdPAPIVersion :> (QueryParam' '[Optional, Strict] "handle" (Range 1 32 Text) :> PostCreated '[JSON] IdP)))
type IdpUpdate = ReqBodyCustomError '[RawXML, JSON] "wai-error" IdPMetadataInfo :> (Capture "id" IdPId :> (QueryParam' '[Optional, Strict] "handle" (Range 1 32 Text) :> Put '[JSON] IdP))
type IdpDelete = Capture "id" IdPId :> (QueryParam' '[Optional, Strict] "purge" Bool :> DeleteNoContent)
type SsoSettingsGet = Get '[JSON] SsoSettings
sparSPIssuer :: (Functor m, HasConfig m) => Maybe TeamId -> m Issuer
sparResponseURI :: (Functor m, HasConfig m) => Maybe TeamId -> m URI
type APIScim = (OmitDocs :> ("v2" :> ScimSiteAPI SparTag)) :<|> ("auth-tokens" :> (CanThrow 'CodeAuthenticationFailed :> (CanThrow 'CodeAuthenticationRequired :> APIScimToken)))
type ScimSiteAPI tag = ToServantApi (ScimSite tag)
data ScimSite tag route = ScimSite {
- config :: route :- ToServantApi ConfigSite
- users :: route :- (Header "Authorization" (AuthData tag) :> ("Users" :> ToServantApi (UserSite tag)))
}
type APIScimToken = (ZOptUser :> APIScimTokenCreate) :<|> ((ZOptUser :> APIScimTokenDelete) :<|> (ZOptUser :> APIScimTokenList))
type APIScimTokenCreate = ReqBody '[JSON] CreateScimToken :> Post '[JSON] CreateScimTokenResponse
type APIScimTokenDelete = QueryParam' '[Required, Strict] "id" ScimTokenId :> DeleteNoContent
type APIScimTokenList = Get '[JSON] ScimTokenList
data SparAPITag

Documentation

type SparAPI = ("sso" :> APISSO) :<|> (("identity-providers" :> APIIDP) :<|> (("scim" :> APIScim) :<|> (OmitDocs :> InternalAPI))) Source #

type DeprecateSSOAPIV1 = Description "DEPRECATED! use /sso/metadata/:tid instead! Details: https://docs.wire.com/understand/single-sign-on/trouble-shooting.html#can-i-use-the-same-sso-login-code-for-multiple-teams" Source #

type APISSO = (DeprecateSSOAPIV1 :> (Deprecated :> ("metadata" :> APIMeta))) :<|> (("metadata" :> (Capture "team" TeamId :> APIMeta)) :<|> (("initiate-login" :> APIAuthReqPrecheck) :<|> (("initiate-login" :> APIAuthReq) :<|> (APIAuthRespLegacy :<|> (APIAuthResp :<|> ("settings" :> SsoSettingsGet)))))) Source #

type CheckOK = Verb 'HEAD 200 Source #

type APIAuthReqPrecheck = QueryParam "success_redirect" URI :> (QueryParam "error_redirect" URI :> (Capture "idp" IdPId :> CheckOK '[PlainText] NoContent)) Source #

type APIAuthReq = QueryParam "success_redirect" URI :> (QueryParam "error_redirect" URI :> (Capture "idp" IdPId :> Get '[HTML] (FormRedirect AuthnRequest))) Source #

type APIAuthRespLegacy = DeprecateSSOAPIV1 :> (Deprecated :> ("finalize-login" :> (MultipartForm Mem AuthnResponseBody :> Post '[PlainText] Void))) Source #

type APIAuthResp = "finalize-login" :> (Capture "team" TeamId :> (MultipartForm Mem AuthnResponseBody :> Post '[PlainText] Void)) Source #

type IdpGetRaw = Capture "id" IdPId :> ("raw" :> Get '[RawXML] RawIdPMetadata) Source #

type IdpGet = Capture "id" IdPId :> Get '[JSON] IdP Source #

type IdpGetAll = Get '[JSON] IdPList Source #

type IdpCreate = ReqBodyCustomError '[RawXML, JSON] "wai-error" IdPMetadataInfo :> (QueryParam' '[Optional, Strict] "replaces" IdPId :> (QueryParam' '[Optional, Strict] "api_version" WireIdPAPIVersion :> (QueryParam' '[Optional, Strict] "handle" (Range 1 32 Text) :> PostCreated '[JSON] IdP))) Source #

See also: validateNewIdP, idpCreate, idpCreateXML.

type IdpUpdate = ReqBodyCustomError '[RawXML, JSON] "wai-error" IdPMetadataInfo :> (Capture "id" IdPId :> (QueryParam' '[Optional, Strict] "handle" (Range 1 32 Text) :> Put '[JSON] IdP)) Source #

type IdpDelete = Capture "id" IdPId :> (QueryParam' '[Optional, Strict] "purge" Bool :> DeleteNoContent) Source #

type SsoSettingsGet = Get '[JSON] SsoSettings Source #

sparSPIssuer :: (Functor m, HasConfig m) => Maybe TeamId -> m Issuer Source #

sparResponseURI :: (Functor m, HasConfig m) => Maybe TeamId -> m URI Source #

type APIScim = (OmitDocs :> ("v2" :> ScimSiteAPI SparTag)) :<|> ("auth-tokens" :> (CanThrow 'CodeAuthenticationFailed :> (CanThrow 'CodeAuthenticationRequired :> APIScimToken))) Source #

type ScimSiteAPI tag = ToServantApi (ScimSite tag) Source #

data ScimSite tag route Source #

This is similar to Site, but does not include the GroupAPI, as we don't support it (we don't implement GroupDB).

Constructors

ScimSite
Fields config :: route :- ToServantApi ConfigSite users :: route :- (Header "Authorization" (AuthData tag) :> ("Users" :> ToServantApi (UserSite tag)))

Instances

Instances details

Generic (ScimSite tag route) Source #
Instance details Defined in Wire.API.Routes.Public.Spar Associated Types type Rep (ScimSite tag route) :: Type -> Type # Methods from :: ScimSite tag route -> Rep (ScimSite tag route) x # to :: Rep (ScimSite tag route) x -> ScimSite tag route #
type Rep (ScimSite tag route) Source #
Instance details Defined in Wire.API.Routes.Public.Spar type Rep (ScimSite tag route) = D1 ('MetaData "ScimSite" "Wire.API.Routes.Public.Spar" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "ScimSite" 'PrefixI 'True) (S1 ('MetaSel ('Just "config") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- ToServantApi ConfigSite)) :*: S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (Header "Authorization" (AuthData tag) :> ("Users" :> ToServantApi (UserSite tag)))))))

type APIScimToken = (ZOptUser :> APIScimTokenCreate) :<|> ((ZOptUser :> APIScimTokenDelete) :<|> (ZOptUser :> APIScimTokenList)) Source #

type APIScimTokenCreate = ReqBody '[JSON] CreateScimToken :> Post '[JSON] CreateScimTokenResponse Source #

type APIScimTokenDelete = QueryParam' '[Required, Strict] "id" ScimTokenId :> DeleteNoContent Source #

type APIScimTokenList = Get '[JSON] ScimTokenList Source #

data SparAPITag Source #

Instances

Instances details

ServiceAPI SparAPITag v Source #
Instance details Defined in Wire.API.Routes.Public.Spar Associated Types type ServiceAPIRoutes SparAPITag Source # type SpecialisedAPIRoutes v SparAPITag Source # Methods serviceSwagger :: OpenApi Source #
type ServiceAPIRoutes SparAPITag Source #
Instance details Defined in Wire.API.Routes.Public.Spar type ServiceAPIRoutes SparAPITag = SparAPI
type SpecialisedAPIRoutes v SparAPITag Source #
Instance details Defined in Wire.API.Routes.Public.Spar type SpecialisedAPIRoutes v SparAPITag = SparAPI