Modulehoauth2-2.14.3Haskell2010

Network.OAuth2.Experiment.Types

11 types
2 classes
1 value

Packagehoauth2-2.14.3
Exports14
LanguageHaskell2010
LicenceMIT
SourceTypes.hs

Idp App

2 declarations

datadata Idp (i :: k)

Idp i consists various endpoints endpoints.

The i is actually phantom type for information only (Idp name) at this moment. And it is PolyKinds.

Hence whenever Idp i or IdpApplication i a is used as function parameter, PolyKinds need to be enabled.

Constructors

Idp
- idpUserInfoEndpoint :: URI
  Userinfo Endpoint
- idpAuthorizeEndpoint :: URI
  Authorization Endpoint
- idpTokenEndpoint :: URI
  Token Endpoint
- idpDeviceAuthorizationEndpoint :: Maybe URI
  Apparently not all IdP support device code flow

datadata IdpApplication (i :: k) a

An OAuth2 Application "a" of IdP "i". "a" can be one of following type:

Network.OAuth2.Experiment.AuthorizationCodeApplication
Network.OAuth2.Experiment.DeviceAuthorizationApplication
Network.OAuth2.Experiment.ClientCredentialsApplication
Network.OAuth2.Experiment.ResourceOwnerPasswordApplication
Network.OAuth2.Experiment.JwtBearerApplication

Constructors

IdpApplication
- idp :: Idp i
- application :: a

Scope

1 declaration

newtypenewtype Scope

Constructors

Scope
- unScope :: Text

Instances5Eq, Ord, Show, IsString, ToQueryParam

Eq ScopeDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
Ord ScopeDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
Show ScopeDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
IsString ScopeDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam (Set Scope)Defined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types

Grant Type value

2 declarations

datadata GrantTypeValue

Grant type query parameter has association with different GrantType flows but not completely strict.

e.g. Both AuthorizationCode and ResourceOwnerPassword flow could support refresh token flow.

GTAuthorizationCode GTPassword GTClientCredentials GTRefreshToken GTJwtBearer GTDeviceCode

Instances3Eq, Show, ToQueryParam

Eq GrantTypeValueDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
Show GrantTypeValueDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam GrantTypeValueDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types

datadata ResponseType

Code

Instances1ToQueryParam

ToQueryParam ResponseTypeDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types

Credentials

7 declarations

newtypenewtype ClientId

Constructors

ClientId
- unClientId :: Text

Instances4Eq, Show, IsString, ToQueryParam

Eq ClientIdDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
Show ClientIdDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
IsString ClientIdDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam ClientIdDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types

newtypenewtype ClientSecret

Can be either "Client Secret" or JWT base on client authentication method

Constructors

ClientSecret
- unClientSecret :: Text

Instances3Eq, IsString, ToQueryParam

Eq ClientSecretDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
IsString ClientSecretDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam ClientSecretDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types

valuetoOAuth2Key :: ClientId -> ClientSecret -> OAuth2

In order to reuse some methods from legacy Network.OAuth.OAuth2. Will be removed when Experiment module becomes default.

newtypenewtype RedirectUri

Constructors

RedirectUri
- unRedirectUri :: URI

Instances2Eq, ToQueryParam

Eq RedirectUriDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam RedirectUriDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types

newtypenewtype AuthorizeState

Constructors

AuthorizeState
- unAuthorizeState :: Text

Instances3Eq, IsString, ToQueryParam

Eq AuthorizeStateDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
IsString AuthorizeStateDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam AuthorizeStateDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types

newtypenewtype Username

Constructors

Username
- unUsername :: Text

Instances3Eq, IsString, ToQueryParam

Eq UsernameDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
IsString UsernameDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam UsernameDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types

newtypenewtype Password

Constructors

Password
- unPassword :: Text

Instances3Eq, IsString, ToQueryParam

Eq PasswordDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
IsString PasswordDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam PasswordDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types

Query parameters

2 declarations

classclass ToQueryParam a where

Methods

toQueryParam :: a -> Map Text Text

Instances24ToQueryParam, …

ToQueryParam ExchangeTokenDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam RefreshTokenDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam AuthorizationRequestParamDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Flows.AuthorizationRequest
ToQueryParam DeviceAuthorizationRequestParamDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Flows.DeviceAuthorizationRequest
ToQueryParam DeviceCodeDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Flows.DeviceAuthorizationRequest
ToQueryParam RefreshTokenRequestDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Flows.RefreshTokenRequest
ToQueryParam CodeChallengeDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam CodeChallengeMethodDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam CodeVerifierDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam AuthorizeStateDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam ClientIdDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam ClientSecretDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam GrantTypeValueDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam PasswordDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam RedirectUriDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam ResponseTypeDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam UsernameDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam (Set Scope)Defined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types
ToQueryParam (TokenRequest AuthorizationCodeApplication)Defined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Grants.AuthorizationCode
ToQueryParam (TokenRequest ClientCredentialsApplication)Defined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Grants.ClientCredentials
ToQueryParam (TokenRequest DeviceAuthorizationApplication)Defined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Grants.DeviceAuthorization
ToQueryParam (TokenRequest JwtBearerApplication)Defined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Grants.JwtBearer
ToQueryParam (TokenRequest ResourceOwnerPasswordApplication)Defined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Grants.ResourceOwnerPassword
ToQueryParam a => ToQueryParam (Maybe a)Defined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Types

classclass HasOAuth2Key a where

Methods

mkOAuth2Key :: a -> OAuth2

Instances5HasOAuth2Key

HasOAuth2Key AuthorizationCodeApplicationDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Grants.AuthorizationCode
HasOAuth2Key ClientCredentialsApplicationDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Grants.ClientCredentials
HasOAuth2Key DeviceAuthorizationApplicationDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Grants.DeviceAuthorization
HasOAuth2Key JwtBearerApplicationDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Grants.JwtBearer
HasOAuth2Key ResourceOwnerPasswordApplicationDefined in hoauth2-2.14.3 · Network.OAuth2.Experiment.Grants.ResourceOwnerPassword