OryHydra.Model

Parameter newtypes

All

newtype All

Constructors

All

Fields

• unAll :: Bool

Instances

Show All

Defined in OryHydra.Model

Methods

showsPrec :: Int -> All -> ShowS

show :: All -> String

showList :: [All] -> ShowS

Eq All

Defined in OryHydra.Model

Methods

(==) :: All -> All -> Bool

(/=) :: All -> All -> Bool

HasOptionalParam RevokeOAuth2ConsentSessions All

Optional Param "all" - Revoke All Consent Sessions If set to true deletes all consent sessions by the Subject that have been granted.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept -> All -> OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept

(-&-) :: OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept -> All -> OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept

Client

newtype Client

Constructors

Client

Fields

• unClient :: Text

Instances

Show Client

Defined in OryHydra.Model

Methods

showsPrec :: Int -> Client -> ShowS

show :: Client -> String

showList :: [Client] -> ShowS

Eq Client

Defined in OryHydra.Model

Methods

(==) :: Client -> Client -> Bool

(/=) :: Client -> Client -> Bool

HasOptionalParam RevokeOAuth2ConsentSessions Client

Optional Param "client" - OAuth 2.0 Client ID If set, deletes only those consent sessions that have been granted to the specified OAuth 2.0 Client ID.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept -> Client -> OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept

(-&-) :: OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept -> Client -> OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept

ClientId

newtype ClientId

Constructors

ClientId

Fields

• unClientId :: Text

Instances

Show ClientId

Defined in OryHydra.Model

Methods

showsPrec :: Int -> ClientId -> ShowS

show :: ClientId -> String

showList :: [ClientId] -> ShowS

Eq ClientId

Defined in OryHydra.Model

Methods

(==) :: ClientId -> ClientId -> Bool

(/=) :: ClientId -> ClientId -> Bool

HasOptionalParam Oauth2TokenExchange ClientId

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest Oauth2TokenExchange contentType res accept -> ClientId -> OryHydraRequest Oauth2TokenExchange contentType res accept

(-&-) :: OryHydraRequest Oauth2TokenExchange contentType res accept -> ClientId -> OryHydraRequest Oauth2TokenExchange contentType res accept

HasOptionalParam RevokeOAuth2Token ClientId

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest RevokeOAuth2Token contentType res accept -> ClientId -> OryHydraRequest RevokeOAuth2Token contentType res accept

(-&-) :: OryHydraRequest RevokeOAuth2Token contentType res accept -> ClientId -> OryHydraRequest RevokeOAuth2Token contentType res accept

ClientName

newtype ClientName

Constructors

ClientName

Fields

• unClientName :: Text

Instances

Show ClientName

Defined in OryHydra.Model

Methods

showsPrec :: Int -> ClientName -> ShowS

show :: ClientName -> String

showList :: [ClientName] -> ShowS

Eq ClientName

Defined in OryHydra.Model

Methods

(==) :: ClientName -> ClientName -> Bool

(/=) :: ClientName -> ClientName -> Bool

HasOptionalParam ListOAuth2Clients ClientName

Optional Param "client_name" - The name of the clients to filter by.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2Clients contentType res accept -> ClientName -> OryHydraRequest ListOAuth2Clients contentType res accept

(-&-) :: OryHydraRequest ListOAuth2Clients contentType res accept -> ClientName -> OryHydraRequest ListOAuth2Clients contentType res accept

ClientSecret

newtype ClientSecret

Constructors

ClientSecret

Fields

• unClientSecret :: Text

Instances

Show ClientSecret

Defined in OryHydra.Model

Methods

showsPrec :: Int -> ClientSecret -> ShowS

show :: ClientSecret -> String

showList :: [ClientSecret] -> ShowS

Eq ClientSecret

Defined in OryHydra.Model

Methods

(==) :: ClientSecret -> ClientSecret -> Bool

(/=) :: ClientSecret -> ClientSecret -> Bool

HasOptionalParam RevokeOAuth2Token ClientSecret

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest RevokeOAuth2Token contentType res accept -> ClientSecret -> OryHydraRequest RevokeOAuth2Token contentType res accept

(-&-) :: OryHydraRequest RevokeOAuth2Token contentType res accept -> ClientSecret -> OryHydraRequest RevokeOAuth2Token contentType res accept

Code

newtype Code

Constructors

Code

Fields

• unCode :: Text

Instances

Show Code

Defined in OryHydra.Model

Methods

showsPrec :: Int -> Code -> ShowS

show :: Code -> String

showList :: [Code] -> ShowS

Eq Code

Defined in OryHydra.Model

Methods

(==) :: Code -> Code -> Bool

(/=) :: Code -> Code -> Bool

HasOptionalParam Oauth2TokenExchange Code

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest Oauth2TokenExchange contentType res accept -> Code -> OryHydraRequest Oauth2TokenExchange contentType res accept

(-&-) :: OryHydraRequest Oauth2TokenExchange contentType res accept -> Code -> OryHydraRequest Oauth2TokenExchange contentType res accept

ConsentChallenge

newtype ConsentChallenge

Constructors

ConsentChallenge

Fields

• unConsentChallenge :: Text

Instances

Show ConsentChallenge

Defined in OryHydra.Model

Methods

showsPrec :: Int -> ConsentChallenge -> ShowS

show :: ConsentChallenge -> String

showList :: [ConsentChallenge] -> ShowS

Eq ConsentChallenge

Defined in OryHydra.Model

Methods

(==) :: ConsentChallenge -> ConsentChallenge -> Bool

(/=) :: ConsentChallenge -> ConsentChallenge -> Bool

DefaultItems

newtype DefaultItems

Constructors

DefaultItems

Fields

• unDefaultItems :: Integer

Instances

Show DefaultItems

Defined in OryHydra.Model

Methods

showsPrec :: Int -> DefaultItems -> ShowS

show :: DefaultItems -> String

showList :: [DefaultItems] -> ShowS

Eq DefaultItems

Defined in OryHydra.Model

Methods

(==) :: DefaultItems -> DefaultItems -> Bool

(/=) :: DefaultItems -> DefaultItems -> Bool

HasOptionalParam ListTrustedOAuth2JwtGrantIssuers DefaultItems

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept -> DefaultItems -> OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept

(-&-) :: OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept -> DefaultItems -> OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept

GrantType

newtype GrantType

Constructors

GrantType

Fields

• unGrantType :: Text

Instances

Show GrantType

Defined in OryHydra.Model

Methods

showsPrec :: Int -> GrantType -> ShowS

show :: GrantType -> String

showList :: [GrantType] -> ShowS

Eq GrantType

Defined in OryHydra.Model

Methods

(==) :: GrantType -> GrantType -> Bool

(/=) :: GrantType -> GrantType -> Bool

Id

newtype Id

Constructors

Id

Fields

• unId :: Text

Instances

Show Id

Defined in OryHydra.Model

Methods

showsPrec :: Int -> Id -> ShowS

show :: Id -> String

showList :: [Id] -> ShowS

Eq Id

Defined in OryHydra.Model

Methods

(==) :: Id -> Id -> Bool

(/=) :: Id -> Id -> Bool

Issuer

newtype Issuer

Constructors

Issuer

Fields

• unIssuer :: Text

Instances

Show Issuer

Defined in OryHydra.Model

Methods

showsPrec :: Int -> Issuer -> ShowS

show :: Issuer -> String

showList :: [Issuer] -> ShowS

Eq Issuer

Defined in OryHydra.Model

Methods

(==) :: Issuer -> Issuer -> Bool

(/=) :: Issuer -> Issuer -> Bool

HasOptionalParam ListTrustedOAuth2JwtGrantIssuers Issuer

Optional Param "issuer" - If optional "issuer" is supplied, only jwt-bearer grants with this issuer will be returned.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept -> Issuer -> OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept

(-&-) :: OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept -> Issuer -> OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept

JsonPatch2

newtype JsonPatch2

Constructors

JsonPatch2

Fields

• unJsonPatch2 :: [JsonPatch]

Instances

ToJSON JsonPatch2

Defined in OryHydra.Model

Methods

toJSON :: JsonPatch2 -> Value

toEncoding :: JsonPatch2 -> Encoding

toJSONList :: [JsonPatch2] -> Value

toEncodingList :: [JsonPatch2] -> Encoding

Show JsonPatch2

Defined in OryHydra.Model

Methods

showsPrec :: Int -> JsonPatch2 -> ShowS

show :: JsonPatch2 -> String

showList :: [JsonPatch2] -> ShowS

Eq JsonPatch2

Defined in OryHydra.Model

Methods

(==) :: JsonPatch2 -> JsonPatch2 -> Bool

(/=) :: JsonPatch2 -> JsonPatch2 -> Bool

HasBodyParam PatchOAuth2Client JsonPatch2

Body Param JsonPatch - OAuth 2.0 Client JSON Patch Body

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes PatchOAuth2Client contentType, MimeRender contentType JsonPatch2) => OryHydraRequest PatchOAuth2Client contentType res accept -> JsonPatch2 -> OryHydraRequest PatchOAuth2Client contentType res accept

Kid

newtype Kid

Constructors

Kid

Fields

• unKid :: Text

Instances

Show Kid

Defined in OryHydra.Model

Methods

showsPrec :: Int -> Kid -> ShowS

show :: Kid -> String

showList :: [Kid] -> ShowS

Eq Kid

Defined in OryHydra.Model

Methods

(==) :: Kid -> Kid -> Bool

(/=) :: Kid -> Kid -> Bool

LoginChallenge

newtype LoginChallenge

Constructors

LoginChallenge

Fields

• unLoginChallenge :: Text

Instances

Show LoginChallenge

Defined in OryHydra.Model

Methods

showsPrec :: Int -> LoginChallenge -> ShowS

show :: LoginChallenge -> String

showList :: [LoginChallenge] -> ShowS

Eq LoginChallenge

Defined in OryHydra.Model

Methods

(==) :: LoginChallenge -> LoginChallenge -> Bool

(/=) :: LoginChallenge -> LoginChallenge -> Bool

LoginSessionId

newtype LoginSessionId

Constructors

LoginSessionId

Fields

• unLoginSessionId :: Text

Instances

Show LoginSessionId

Defined in OryHydra.Model

Methods

showsPrec :: Int -> LoginSessionId -> ShowS

show :: LoginSessionId -> String

showList :: [LoginSessionId] -> ShowS

Eq LoginSessionId

Defined in OryHydra.Model

Methods

(==) :: LoginSessionId -> LoginSessionId -> Bool

(/=) :: LoginSessionId -> LoginSessionId -> Bool

HasOptionalParam ListOAuth2ConsentSessions LoginSessionId

Optional Param "login_session_id" - The login session id to list the consent sessions for.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2ConsentSessions contentType res accept -> LoginSessionId -> OryHydraRequest ListOAuth2ConsentSessions contentType res accept

(-&-) :: OryHydraRequest ListOAuth2ConsentSessions contentType res accept -> LoginSessionId -> OryHydraRequest ListOAuth2ConsentSessions contentType res accept

LogoutChallenge

newtype LogoutChallenge

Constructors

LogoutChallenge

Fields

• unLogoutChallenge :: Text

Instances

Show LogoutChallenge

Defined in OryHydra.Model

Methods

showsPrec :: Int -> LogoutChallenge -> ShowS

show :: LogoutChallenge -> String

showList :: [LogoutChallenge] -> ShowS

Eq LogoutChallenge

Defined in OryHydra.Model

Methods

(==) :: LogoutChallenge -> LogoutChallenge -> Bool

(/=) :: LogoutChallenge -> LogoutChallenge -> Bool

MaxItems

newtype MaxItems

Constructors

MaxItems

Fields

• unMaxItems :: Integer

Instances

Show MaxItems

Defined in OryHydra.Model

Methods

showsPrec :: Int -> MaxItems -> ShowS

show :: MaxItems -> String

showList :: [MaxItems] -> ShowS

Eq MaxItems

Defined in OryHydra.Model

Methods

(==) :: MaxItems -> MaxItems -> Bool

(/=) :: MaxItems -> MaxItems -> Bool

HasOptionalParam ListTrustedOAuth2JwtGrantIssuers MaxItems

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept -> MaxItems -> OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept

(-&-) :: OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept -> MaxItems -> OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept

Owner

newtype Owner

Constructors

Owner

Fields

• unOwner :: Text

Instances

Show Owner

Defined in OryHydra.Model

Methods

showsPrec :: Int -> Owner -> ShowS

show :: Owner -> String

showList :: [Owner] -> ShowS

Eq Owner

Defined in OryHydra.Model

Methods

(==) :: Owner -> Owner -> Bool

(/=) :: Owner -> Owner -> Bool

HasOptionalParam ListOAuth2Clients Owner

Optional Param "owner" - The owner of the clients to filter by.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2Clients contentType res accept -> Owner -> OryHydraRequest ListOAuth2Clients contentType res accept

(-&-) :: OryHydraRequest ListOAuth2Clients contentType res accept -> Owner -> OryHydraRequest ListOAuth2Clients contentType res accept

PageSize

newtype PageSize

Constructors

PageSize

Fields

• unPageSize :: Integer

Instances

Show PageSize

Defined in OryHydra.Model

Methods

showsPrec :: Int -> PageSize -> ShowS

show :: PageSize -> String

showList :: [PageSize] -> ShowS

Eq PageSize

Defined in OryHydra.Model

Methods

(==) :: PageSize -> PageSize -> Bool

(/=) :: PageSize -> PageSize -> Bool

HasOptionalParam ListOAuth2Clients PageSize

Optional Param "page_size" - Items per Page This is the number of items per page to return. For details on pagination please head over to the pagination documentation.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2Clients contentType res accept -> PageSize -> OryHydraRequest ListOAuth2Clients contentType res accept

(-&-) :: OryHydraRequest ListOAuth2Clients contentType res accept -> PageSize -> OryHydraRequest ListOAuth2Clients contentType res accept

HasOptionalParam ListOAuth2ConsentSessions PageSize

Optional Param "page_size" - Items per Page This is the number of items per page to return. For details on pagination please head over to the pagination documentation.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2ConsentSessions contentType res accept -> PageSize -> OryHydraRequest ListOAuth2ConsentSessions contentType res accept

(-&-) :: OryHydraRequest ListOAuth2ConsentSessions contentType res accept -> PageSize -> OryHydraRequest ListOAuth2ConsentSessions contentType res accept

PageToken

newtype PageToken

Constructors

PageToken

Fields

• unPageToken :: Text

Instances

Show PageToken

Defined in OryHydra.Model

Methods

showsPrec :: Int -> PageToken -> ShowS

show :: PageToken -> String

showList :: [PageToken] -> ShowS

Eq PageToken

Defined in OryHydra.Model

Methods

(==) :: PageToken -> PageToken -> Bool

(/=) :: PageToken -> PageToken -> Bool

HasOptionalParam ListOAuth2Clients PageToken

Optional Param "page_token" - Next Page Token The next page token. For details on pagination please head over to the pagination documentation.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2Clients contentType res accept -> PageToken -> OryHydraRequest ListOAuth2Clients contentType res accept

(-&-) :: OryHydraRequest ListOAuth2Clients contentType res accept -> PageToken -> OryHydraRequest ListOAuth2Clients contentType res accept

HasOptionalParam ListOAuth2ConsentSessions PageToken

Optional Param "page_token" - Next Page Token The next page token. For details on pagination please head over to the pagination documentation.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2ConsentSessions contentType res accept -> PageToken -> OryHydraRequest ListOAuth2ConsentSessions contentType res accept

(-&-) :: OryHydraRequest ListOAuth2ConsentSessions contentType res accept -> PageToken -> OryHydraRequest ListOAuth2ConsentSessions contentType res accept

RedirectUri

newtype RedirectUri

Constructors

RedirectUri

Fields

• unRedirectUri :: Text

Instances

Show RedirectUri

Defined in OryHydra.Model

Methods

showsPrec :: Int -> RedirectUri -> ShowS

show :: RedirectUri -> String

showList :: [RedirectUri] -> ShowS

Eq RedirectUri

Defined in OryHydra.Model

Methods

(==) :: RedirectUri -> RedirectUri -> Bool

(/=) :: RedirectUri -> RedirectUri -> Bool

HasOptionalParam Oauth2TokenExchange RedirectUri

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest Oauth2TokenExchange contentType res accept -> RedirectUri -> OryHydraRequest Oauth2TokenExchange contentType res accept

(-&-) :: OryHydraRequest Oauth2TokenExchange contentType res accept -> RedirectUri -> OryHydraRequest Oauth2TokenExchange contentType res accept

RefreshToken

newtype RefreshToken

Constructors

RefreshToken

Fields

• unRefreshToken :: Text

Instances

Show RefreshToken

Defined in OryHydra.Model

Methods

showsPrec :: Int -> RefreshToken -> ShowS

show :: RefreshToken -> String

showList :: [RefreshToken] -> ShowS

Eq RefreshToken

Defined in OryHydra.Model

Methods

(==) :: RefreshToken -> RefreshToken -> Bool

(/=) :: RefreshToken -> RefreshToken -> Bool

HasOptionalParam Oauth2TokenExchange RefreshToken

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest Oauth2TokenExchange contentType res accept -> RefreshToken -> OryHydraRequest Oauth2TokenExchange contentType res accept

(-&-) :: OryHydraRequest Oauth2TokenExchange contentType res accept -> RefreshToken -> OryHydraRequest Oauth2TokenExchange contentType res accept

Scope

newtype Scope

Constructors

Scope

Fields

• unScope :: Text

Instances

Show Scope

Defined in OryHydra.Model

Methods

showsPrec :: Int -> Scope -> ShowS

show :: Scope -> String

showList :: [Scope] -> ShowS

Eq Scope

Defined in OryHydra.Model

Methods

(==) :: Scope -> Scope -> Bool

(/=) :: Scope -> Scope -> Bool

HasOptionalParam IntrospectOAuth2Token Scope

Optional Param "scope" - An optional, space separated list of required scopes. If the access token was not granted one of the scopes, the result of active will be false.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest IntrospectOAuth2Token contentType res accept -> Scope -> OryHydraRequest IntrospectOAuth2Token contentType res accept

(-&-) :: OryHydraRequest IntrospectOAuth2Token contentType res accept -> Scope -> OryHydraRequest IntrospectOAuth2Token contentType res accept

Set

newtype Set

Constructors

Set

Fields

• unSet :: Text

Instances

Show Set

Defined in OryHydra.Model

Methods

showsPrec :: Int -> Set -> ShowS

show :: Set -> String

showList :: [Set] -> ShowS

Eq Set

Defined in OryHydra.Model

Methods

(==) :: Set -> Set -> Bool

(/=) :: Set -> Set -> Bool

Subject

newtype Subject

Constructors

Subject

Fields

• unSubject :: Text

Instances

Show Subject

Defined in OryHydra.Model

Methods

showsPrec :: Int -> Subject -> ShowS

show :: Subject -> String

showList :: [Subject] -> ShowS

Eq Subject

Defined in OryHydra.Model

Methods

(==) :: Subject -> Subject -> Bool

(/=) :: Subject -> Subject -> Bool

Token

newtype Token

Constructors

Token

Fields

• unToken :: Text

Instances

Show Token

Defined in OryHydra.Model

Methods

showsPrec :: Int -> Token -> ShowS

show :: Token -> String

showList :: [Token] -> ShowS

Eq Token

Defined in OryHydra.Model

Methods

(==) :: Token -> Token -> Bool

(/=) :: Token -> Token -> Bool

Models

AcceptOAuth2ConsentRequest

data AcceptOAuth2ConsentRequest

AcceptOAuth2ConsentRequest The request payload used to accept a consent request.

Constructors

AcceptOAuth2ConsentRequest

Fields

• acceptOAuth2ConsentRequestGrantAccessTokenAudience :: Maybe [Text]

  "grant_access_token_audience"

• acceptOAuth2ConsentRequestGrantScope :: Maybe [Text]

  "grant_scope"

• acceptOAuth2ConsentRequestHandledAt :: Maybe DateTime

  "handled_at"

• acceptOAuth2ConsentRequestRemember :: Maybe Bool

  "remember" - Remember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same client asks the same user for the same, or a subset of, scope.

• acceptOAuth2ConsentRequestRememberFor :: Maybe Integer

  "remember_for" - RememberFor sets how long the consent authorization should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely.

• acceptOAuth2ConsentRequestSession :: Maybe AcceptOAuth2ConsentRequestSession

  "session"

Instances

FromJSON AcceptOAuth2ConsentRequest

FromJSON AcceptOAuth2ConsentRequest

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser AcceptOAuth2ConsentRequest

parseJSONList :: Value -> Parser [AcceptOAuth2ConsentRequest]

ToJSON AcceptOAuth2ConsentRequest

ToJSON AcceptOAuth2ConsentRequest

Defined in OryHydra.Model

Methods

toJSON :: AcceptOAuth2ConsentRequest -> Value

toEncoding :: AcceptOAuth2ConsentRequest -> Encoding

toJSONList :: [AcceptOAuth2ConsentRequest] -> Value

toEncodingList :: [AcceptOAuth2ConsentRequest] -> Encoding

Show AcceptOAuth2ConsentRequest

Defined in OryHydra.Model

Methods

showsPrec :: Int -> AcceptOAuth2ConsentRequest -> ShowS

show :: AcceptOAuth2ConsentRequest -> String

showList :: [AcceptOAuth2ConsentRequest] -> ShowS

Eq AcceptOAuth2ConsentRequest

Defined in OryHydra.Model

Methods

(==) :: AcceptOAuth2ConsentRequest -> AcceptOAuth2ConsentRequest -> Bool

(/=) :: AcceptOAuth2ConsentRequest -> AcceptOAuth2ConsentRequest -> Bool

HasBodyParam AcceptOAuth2ConsentRequest0 AcceptOAuth2ConsentRequest

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes AcceptOAuth2ConsentRequest0 contentType, MimeRender contentType AcceptOAuth2ConsentRequest) => OryHydraRequest AcceptOAuth2ConsentRequest0 contentType res accept -> AcceptOAuth2ConsentRequest -> OryHydraRequest AcceptOAuth2ConsentRequest0 contentType res accept

mkAcceptOAuth2ConsentRequest :: AcceptOAuth2ConsentRequest

Construct a value of type AcceptOAuth2ConsentRequest (by applying it's required fields, if any)

AcceptOAuth2ConsentRequestSession

data AcceptOAuth2ConsentRequestSession

AcceptOAuth2ConsentRequestSession Pass session data to a consent request.

Constructors

AcceptOAuth2ConsentRequestSession

Fields

• acceptOAuth2ConsentRequestSessionAccessToken :: Maybe Value

  "access_token" - AccessToken sets session data for the access and refresh token, as well as any future tokens issued by the refresh grant. Keep in mind that this data will be available to anyone performing OAuth 2.0 Challenge Introspection. If only your services can perform OAuth 2.0 Challenge Introspection, this is usually fine. But if third parties can access that endpoint as well, sensitive data from the session might be exposed to them. Use with care!

• acceptOAuth2ConsentRequestSessionIdToken :: Maybe Value

  "id_token" - IDToken sets session data for the OpenID Connect ID token. Keep in mind that the session'id payloads are readable by anyone that has access to the ID Challenge. Use with care!

Instances

FromJSON AcceptOAuth2ConsentRequestSession

FromJSON AcceptOAuth2ConsentRequestSession

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser AcceptOAuth2ConsentRequestSession

parseJSONList :: Value -> Parser [AcceptOAuth2ConsentRequestSession]

ToJSON AcceptOAuth2ConsentRequestSession

ToJSON AcceptOAuth2ConsentRequestSession

Defined in OryHydra.Model

Methods

toJSON :: AcceptOAuth2ConsentRequestSession -> Value

toEncoding :: AcceptOAuth2ConsentRequestSession -> Encoding

toJSONList :: [AcceptOAuth2ConsentRequestSession] -> Value

toEncodingList :: [AcceptOAuth2ConsentRequestSession] -> Encoding

Show AcceptOAuth2ConsentRequestSession

Defined in OryHydra.Model

Methods

showsPrec :: Int -> AcceptOAuth2ConsentRequestSession -> ShowS

show :: AcceptOAuth2ConsentRequestSession -> String

showList :: [AcceptOAuth2ConsentRequestSession] -> ShowS

Eq AcceptOAuth2ConsentRequestSession

Defined in OryHydra.Model

Methods

(==) :: AcceptOAuth2ConsentRequestSession -> AcceptOAuth2ConsentRequestSession -> Bool

(/=) :: AcceptOAuth2ConsentRequestSession -> AcceptOAuth2ConsentRequestSession -> Bool

mkAcceptOAuth2ConsentRequestSession :: AcceptOAuth2ConsentRequestSession

Construct a value of type AcceptOAuth2ConsentRequestSession (by applying it's required fields, if any)

AcceptOAuth2LoginRequest

data AcceptOAuth2LoginRequest

AcceptOAuth2LoginRequest HandledLoginRequest is the request payload used to accept a login request.

Constructors

AcceptOAuth2LoginRequest

Fields

• acceptOAuth2LoginRequestAcr :: Maybe Text

  "acr" - ACR sets the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication.

• acceptOAuth2LoginRequestAmr :: Maybe [Text]

  "amr"

• acceptOAuth2LoginRequestContext :: Maybe Value

  "context"

• acceptOAuth2LoginRequestForceSubjectIdentifier :: Maybe Text

  "force_subject_identifier" - ForceSubjectIdentifier forces the "pairwise" user ID of the end-user that authenticated. The "pairwise" user ID refers to the (Pairwise Identifier Algorithm)[http:/openid.netspecsopenid-connect-core-1_0.html#PairwiseAlg] of the OpenID Connect specification. It allows you to set an obfuscated subject ("user") identifier that is unique to the client. Please note that this changes the user ID on endpoint userinfo and sub claim of the ID Token. It does not change the sub claim in the OAuth 2.0 Introspection. Per default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself you can use this field. Please note that setting this field has no effect if `pairwise` is not configured in ORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via `subject_type` key in the client's configuration). Please also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies that you have to compute this value on every authentication process (probably depending on the client ID or some other unique value). If you fail to compute the proper value, then authentication processes which have id_token_hint set might fail.

• acceptOAuth2LoginRequestRemember :: Maybe Bool

  "remember" - Remember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store a cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, he/she will not be asked to log in again.

• acceptOAuth2LoginRequestRememberFor :: Maybe Integer

  "remember_for" - RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered for the duration of the browser session (using a session cookie).

• acceptOAuth2LoginRequestSubject :: Text

  Required "subject" - Subject is the user ID of the end-user that authenticated.

Instances

FromJSON AcceptOAuth2LoginRequest

FromJSON AcceptOAuth2LoginRequest

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser AcceptOAuth2LoginRequest

parseJSONList :: Value -> Parser [AcceptOAuth2LoginRequest]

ToJSON AcceptOAuth2LoginRequest

ToJSON AcceptOAuth2LoginRequest

Defined in OryHydra.Model

Methods

toJSON :: AcceptOAuth2LoginRequest -> Value

toEncoding :: AcceptOAuth2LoginRequest -> Encoding

toJSONList :: [AcceptOAuth2LoginRequest] -> Value

toEncodingList :: [AcceptOAuth2LoginRequest] -> Encoding

Show AcceptOAuth2LoginRequest

Defined in OryHydra.Model

Methods

showsPrec :: Int -> AcceptOAuth2LoginRequest -> ShowS

show :: AcceptOAuth2LoginRequest -> String

showList :: [AcceptOAuth2LoginRequest] -> ShowS

Eq AcceptOAuth2LoginRequest

Defined in OryHydra.Model

Methods

(==) :: AcceptOAuth2LoginRequest -> AcceptOAuth2LoginRequest -> Bool

(/=) :: AcceptOAuth2LoginRequest -> AcceptOAuth2LoginRequest -> Bool

HasBodyParam AcceptOAuth2LoginRequest0 AcceptOAuth2LoginRequest

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes AcceptOAuth2LoginRequest0 contentType, MimeRender contentType AcceptOAuth2LoginRequest) => OryHydraRequest AcceptOAuth2LoginRequest0 contentType res accept -> AcceptOAuth2LoginRequest -> OryHydraRequest AcceptOAuth2LoginRequest0 contentType res accept

mkAcceptOAuth2LoginRequest

Arguments

:: Text

acceptOAuth2LoginRequestSubject: Subject is the user ID of the end-user that authenticated.

-> AcceptOAuth2LoginRequest

Construct a value of type AcceptOAuth2LoginRequest (by applying it's required fields, if any)

CreateJsonWebKeySet

data CreateJsonWebKeySet

CreateJsonWebKeySet Create JSON Web Key Set Request Body

Constructors

CreateJsonWebKeySet

Fields

• createJsonWebKeySetAlg :: Text

  Required "alg" - JSON Web Key Algorithm The algorithm to be used for creating the key. Supports `RS256`, `ES256`, `ES512`, `HS512`, and `HS256`.

• createJsonWebKeySetKid :: Text

  Required "kid" - JSON Web Key ID The Key ID of the key to be created.

• createJsonWebKeySetUse :: Text

  Required "use" - JSON Web Key Use The "use" (public key use) parameter identifies the intended use of the public key. The "use" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Valid values are "enc" and "sig".

Instances

FromJSON CreateJsonWebKeySet

FromJSON CreateJsonWebKeySet

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser CreateJsonWebKeySet

parseJSONList :: Value -> Parser [CreateJsonWebKeySet]

ToJSON CreateJsonWebKeySet

ToJSON CreateJsonWebKeySet

Defined in OryHydra.Model

Methods

toJSON :: CreateJsonWebKeySet -> Value

toEncoding :: CreateJsonWebKeySet -> Encoding

toJSONList :: [CreateJsonWebKeySet] -> Value

toEncodingList :: [CreateJsonWebKeySet] -> Encoding

Show CreateJsonWebKeySet

Defined in OryHydra.Model

Methods

showsPrec :: Int -> CreateJsonWebKeySet -> ShowS

show :: CreateJsonWebKeySet -> String

showList :: [CreateJsonWebKeySet] -> ShowS

Eq CreateJsonWebKeySet

Defined in OryHydra.Model

Methods

(==) :: CreateJsonWebKeySet -> CreateJsonWebKeySet -> Bool

(/=) :: CreateJsonWebKeySet -> CreateJsonWebKeySet -> Bool

HasBodyParam CreateJsonWebKeySet0 CreateJsonWebKeySet

Defined in OryHydra.API.Jwk

Methods

setBodyParam :: (Consumes CreateJsonWebKeySet0 contentType, MimeRender contentType CreateJsonWebKeySet) => OryHydraRequest CreateJsonWebKeySet0 contentType res accept -> CreateJsonWebKeySet -> OryHydraRequest CreateJsonWebKeySet0 contentType res accept

mkCreateJsonWebKeySet

Arguments

:: Text

createJsonWebKeySetAlg: JSON Web Key Algorithm The algorithm to be used for creating the key. Supports RS256, ES256, ES512, HS512, and HS256.

-> Text

createJsonWebKeySetKid: JSON Web Key ID The Key ID of the key to be created.

-> Text

createJsonWebKeySetUse: JSON Web Key Use The "use" (public key use) parameter identifies the intended use of the public key. The "use" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Valid values are "enc" and "sig".

-> CreateJsonWebKeySet

Construct a value of type CreateJsonWebKeySet (by applying it's required fields, if any)

ErrorOAuth2

data ErrorOAuth2

ErrorOAuth2 Error

Constructors

ErrorOAuth2

Fields

• errorOAuth2Error :: Maybe Text

  "error" - Error

• errorOAuth2ErrorDebug :: Maybe Text

  "error_debug" - Error Debug Information Only available in dev mode.

• errorOAuth2ErrorDescription :: Maybe Text

  "error_description" - Error Description

• errorOAuth2ErrorHint :: Maybe Text

  "error_hint" - Error Hint Helps the user identify the error cause.

• errorOAuth2StatusCode :: Maybe Integer

  "status_code" - HTTP Status Code

Instances

FromJSON ErrorOAuth2

FromJSON ErrorOAuth2

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser ErrorOAuth2

parseJSONList :: Value -> Parser [ErrorOAuth2]

ToJSON ErrorOAuth2

ToJSON ErrorOAuth2

Defined in OryHydra.Model

Methods

toJSON :: ErrorOAuth2 -> Value

toEncoding :: ErrorOAuth2 -> Encoding

toJSONList :: [ErrorOAuth2] -> Value

toEncodingList :: [ErrorOAuth2] -> Encoding

Show ErrorOAuth2

Defined in OryHydra.Model

Methods

showsPrec :: Int -> ErrorOAuth2 -> ShowS

show :: ErrorOAuth2 -> String

showList :: [ErrorOAuth2] -> ShowS

Eq ErrorOAuth2

Defined in OryHydra.Model

Methods

(==) :: ErrorOAuth2 -> ErrorOAuth2 -> Bool

(/=) :: ErrorOAuth2 -> ErrorOAuth2 -> Bool

mkErrorOAuth2 :: ErrorOAuth2

Construct a value of type ErrorOAuth2 (by applying it's required fields, if any)

GenericError

data GenericError

GenericError

Constructors

GenericError

Fields

• genericErrorCode :: Maybe Integer

  "code" - The status code

• genericErrorDebug :: Maybe Text

  "debug" - Debug information This field is often not exposed to protect against leaking sensitive information.

• genericErrorDetails :: Maybe Value

  "details" - Further error details

• genericErrorId :: Maybe Text

  "id" - The error ID Useful when trying to identify various errors in application logic.

• genericErrorMessage :: Text

  Required "message" - Error message The error's message.

• genericErrorReason :: Maybe Text

  "reason" - A human-readable reason for the error

• genericErrorRequest :: Maybe Text

  "request" - The request ID The request ID is often exposed internally in order to trace errors across service architectures. This is often a UUID.

• genericErrorStatus :: Maybe Text

  "status" - The status description

Instances

FromJSON GenericError

FromJSON GenericError

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser GenericError

parseJSONList :: Value -> Parser [GenericError]

ToJSON GenericError

ToJSON GenericError

Defined in OryHydra.Model

Methods

toJSON :: GenericError -> Value

toEncoding :: GenericError -> Encoding

toJSONList :: [GenericError] -> Value

toEncodingList :: [GenericError] -> Encoding

Show GenericError

Defined in OryHydra.Model

Methods

showsPrec :: Int -> GenericError -> ShowS

show :: GenericError -> String

showList :: [GenericError] -> ShowS

Eq GenericError

Defined in OryHydra.Model

Methods

(==) :: GenericError -> GenericError -> Bool

(/=) :: GenericError -> GenericError -> Bool

mkGenericError

Arguments

:: Text

genericErrorMessage: Error message The error's message.

-> GenericError

Construct a value of type GenericError (by applying it's required fields, if any)

GetVersion200Response

data GetVersion200Response

GetVersion200Response

Constructors

GetVersion200Response

Fields

• getVersion200ResponseVersion :: Maybe Text

  "version" - The version of Ory Hydra.

Instances

FromJSON GetVersion200Response

FromJSON GetVersion200Response

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser GetVersion200Response

parseJSONList :: Value -> Parser [GetVersion200Response]

ToJSON GetVersion200Response

ToJSON GetVersion200Response

Defined in OryHydra.Model

Methods

toJSON :: GetVersion200Response -> Value

toEncoding :: GetVersion200Response -> Encoding

toJSONList :: [GetVersion200Response] -> Value

toEncodingList :: [GetVersion200Response] -> Encoding

Show GetVersion200Response

Defined in OryHydra.Model

Methods

showsPrec :: Int -> GetVersion200Response -> ShowS

show :: GetVersion200Response -> String

showList :: [GetVersion200Response] -> ShowS

Eq GetVersion200Response

Defined in OryHydra.Model

Methods

(==) :: GetVersion200Response -> GetVersion200Response -> Bool

(/=) :: GetVersion200Response -> GetVersion200Response -> Bool

mkGetVersion200Response :: GetVersion200Response

Construct a value of type GetVersion200Response (by applying it's required fields, if any)

HealthNotReadyStatus

data HealthNotReadyStatus

HealthNotReadyStatus

Constructors

HealthNotReadyStatus

Fields

• healthNotReadyStatusErrors :: Maybe (Map String Text)

  "errors" - Errors contains a list of errors that caused the not ready status.

Instances

FromJSON HealthNotReadyStatus

FromJSON HealthNotReadyStatus

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser HealthNotReadyStatus

parseJSONList :: Value -> Parser [HealthNotReadyStatus]

ToJSON HealthNotReadyStatus

ToJSON HealthNotReadyStatus

Defined in OryHydra.Model

Methods

toJSON :: HealthNotReadyStatus -> Value

toEncoding :: HealthNotReadyStatus -> Encoding

toJSONList :: [HealthNotReadyStatus] -> Value

toEncodingList :: [HealthNotReadyStatus] -> Encoding

Show HealthNotReadyStatus

Defined in OryHydra.Model

Methods

showsPrec :: Int -> HealthNotReadyStatus -> ShowS

show :: HealthNotReadyStatus -> String

showList :: [HealthNotReadyStatus] -> ShowS

Eq HealthNotReadyStatus

Defined in OryHydra.Model

Methods

(==) :: HealthNotReadyStatus -> HealthNotReadyStatus -> Bool

(/=) :: HealthNotReadyStatus -> HealthNotReadyStatus -> Bool

mkHealthNotReadyStatus :: HealthNotReadyStatus

Construct a value of type HealthNotReadyStatus (by applying it's required fields, if any)

HealthStatus

data HealthStatus

HealthStatus

Constructors

HealthStatus

Fields

• healthStatusStatus :: Maybe Text

  "status" - Status always contains "ok".

Instances

FromJSON HealthStatus

FromJSON HealthStatus

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser HealthStatus

parseJSONList :: Value -> Parser [HealthStatus]

ToJSON HealthStatus

ToJSON HealthStatus

Defined in OryHydra.Model

Methods

toJSON :: HealthStatus -> Value

toEncoding :: HealthStatus -> Encoding

toJSONList :: [HealthStatus] -> Value

toEncodingList :: [HealthStatus] -> Encoding

Show HealthStatus

Defined in OryHydra.Model

Methods

showsPrec :: Int -> HealthStatus -> ShowS

show :: HealthStatus -> String

showList :: [HealthStatus] -> ShowS

Eq HealthStatus

Defined in OryHydra.Model

Methods

(==) :: HealthStatus -> HealthStatus -> Bool

(/=) :: HealthStatus -> HealthStatus -> Bool

mkHealthStatus :: HealthStatus

Construct a value of type HealthStatus (by applying it's required fields, if any)

IntrospectedOAuth2Token

data IntrospectedOAuth2Token

IntrospectedOAuth2Token Introspection contains an access token's session data as specified by IETF RFC 7662

Constructors

IntrospectedOAuth2Token

Fields

• introspectedOAuth2TokenActive :: Bool

  Required "active" - Active is a boolean indicator of whether or not the presented token is currently active. The specifics of a token's "active" state will vary depending on the implementation of the authorization server and the information it keeps about its tokens, but a "true" value return for the "active" property will generally indicate that a given token has been issued by this authorization server, has not been revoked by the resource owner, and is within its given time window of validity (e.g., after its issuance time and before its expiration time).

• introspectedOAuth2TokenAud :: Maybe [Text]

  "aud" - Audience contains a list of the token's intended audiences.

• introspectedOAuth2TokenClientId :: Maybe Text

  "client_id" - ID is aclient identifier for the OAuth 2.0 client that requested this token.

• introspectedOAuth2TokenExp :: Maybe Integer

  "exp" - Expires at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire.

• introspectedOAuth2TokenExt :: Maybe (Map String Value)

  "ext" - Extra is arbitrary data set by the session.

• introspectedOAuth2TokenIat :: Maybe Integer

  "iat" - Issued at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued.

• introspectedOAuth2TokenIss :: Maybe Text

  "iss" - IssuerURL is a string representing the issuer of this token

• introspectedOAuth2TokenNbf :: Maybe Integer

  "nbf" - NotBefore is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token is not to be used before.

• introspectedOAuth2TokenObfuscatedSubject :: Maybe Text

  "obfuscated_subject" - ObfuscatedSubject is set when the subject identifier algorithm was set to "pairwise" during authorization. It is the `sub` value of the ID Token that was issued.

• introspectedOAuth2TokenScope :: Maybe Text

  "scope" - Scope is a JSON string containing a space-separated list of scopes associated with this token.

• introspectedOAuth2TokenSub :: Maybe Text

  "sub" - Subject of the token, as defined in JWT [RFC7519]. Usually a machine-readable identifier of the resource owner who authorized this token.

• introspectedOAuth2TokenTokenType :: Maybe Text

  "token_type" - TokenType is the introspected token's type, typically `Bearer`.

• introspectedOAuth2TokenTokenUse :: Maybe Text

  "token_use" - TokenUse is the introspected token's use, for example `access_token` or `refresh_token`.

• introspectedOAuth2TokenUsername :: Maybe Text

  "username" - Username is a human-readable identifier for the resource owner who authorized this token.

Instances

FromJSON IntrospectedOAuth2Token

FromJSON IntrospectedOAuth2Token

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser IntrospectedOAuth2Token

parseJSONList :: Value -> Parser [IntrospectedOAuth2Token]

ToJSON IntrospectedOAuth2Token

ToJSON IntrospectedOAuth2Token

Defined in OryHydra.Model

Methods

toJSON :: IntrospectedOAuth2Token -> Value

toEncoding :: IntrospectedOAuth2Token -> Encoding

toJSONList :: [IntrospectedOAuth2Token] -> Value

toEncodingList :: [IntrospectedOAuth2Token] -> Encoding

Show IntrospectedOAuth2Token

Defined in OryHydra.Model

Methods

showsPrec :: Int -> IntrospectedOAuth2Token -> ShowS

show :: IntrospectedOAuth2Token -> String

showList :: [IntrospectedOAuth2Token] -> ShowS

Eq IntrospectedOAuth2Token

Defined in OryHydra.Model

Methods

(==) :: IntrospectedOAuth2Token -> IntrospectedOAuth2Token -> Bool

(/=) :: IntrospectedOAuth2Token -> IntrospectedOAuth2Token -> Bool

mkIntrospectedOAuth2Token

Arguments

:: Bool

introspectedOAuth2TokenActive: Active is a boolean indicator of whether or not the presented token is currently active. The specifics of a token's "active" state will vary depending on the implementation of the authorization server and the information it keeps about its tokens, but a "true" value return for the "active" property will generally indicate that a given token has been issued by this authorization server, has not been revoked by the resource owner, and is within its given time window of validity (e.g., after its issuance time and before its expiration time).

-> IntrospectedOAuth2Token

Construct a value of type IntrospectedOAuth2Token (by applying it's required fields, if any)

IsReady200Response

data IsReady200Response

IsReady200Response

Constructors

IsReady200Response

Fields

• isReady200ResponseStatus :: Maybe Text

  "status" - Always "ok".

Instances

FromJSON IsReady200Response

FromJSON IsReady200Response

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser IsReady200Response

parseJSONList :: Value -> Parser [IsReady200Response]

ToJSON IsReady200Response

ToJSON IsReady200Response

Defined in OryHydra.Model

Methods

toJSON :: IsReady200Response -> Value

toEncoding :: IsReady200Response -> Encoding

toJSONList :: [IsReady200Response] -> Value

toEncodingList :: [IsReady200Response] -> Encoding

Show IsReady200Response

Defined in OryHydra.Model

Methods

showsPrec :: Int -> IsReady200Response -> ShowS

show :: IsReady200Response -> String

showList :: [IsReady200Response] -> ShowS

Eq IsReady200Response

Defined in OryHydra.Model

Methods

(==) :: IsReady200Response -> IsReady200Response -> Bool

(/=) :: IsReady200Response -> IsReady200Response -> Bool

mkIsReady200Response :: IsReady200Response

Construct a value of type IsReady200Response (by applying it's required fields, if any)

IsReady503Response

data IsReady503Response

IsReady503Response

Constructors

IsReady503Response

Fields

• isReady503ResponseErrors :: Maybe (Map String Text)

  "errors" - Errors contains a list of errors that caused the not ready status.

Instances

FromJSON IsReady503Response

FromJSON IsReady503Response

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser IsReady503Response

parseJSONList :: Value -> Parser [IsReady503Response]

ToJSON IsReady503Response

ToJSON IsReady503Response

Defined in OryHydra.Model

Methods

toJSON :: IsReady503Response -> Value

toEncoding :: IsReady503Response -> Encoding

toJSONList :: [IsReady503Response] -> Value

toEncodingList :: [IsReady503Response] -> Encoding

Show IsReady503Response

Defined in OryHydra.Model

Methods

showsPrec :: Int -> IsReady503Response -> ShowS

show :: IsReady503Response -> String

showList :: [IsReady503Response] -> ShowS

Eq IsReady503Response

Defined in OryHydra.Model

Methods

(==) :: IsReady503Response -> IsReady503Response -> Bool

(/=) :: IsReady503Response -> IsReady503Response -> Bool

mkIsReady503Response :: IsReady503Response

Construct a value of type IsReady503Response (by applying it's required fields, if any)

JsonPatch

data JsonPatch

JsonPatch A JSONPatch document as defined by RFC 6902

Constructors

JsonPatch

Fields

• jsonPatchFrom :: Maybe Text

  "from" - This field is used together with operation "move" and uses JSON Pointer notation. Learn more about JSON Pointers.

• jsonPatchOp :: Text

  Required "op" - The operation to be performed. One of "add", "remove", "replace", "move", "copy", or "test".

• jsonPatchPath :: Text

  Required "path" - The path to the target path. Uses JSON pointer notation. Learn more about JSON Pointers.

• jsonPatchValue :: Maybe Value

  "value" - The value to be used within the operations. Learn more about JSON Pointers.

Instances

FromJSON JsonPatch

FromJSON JsonPatch

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser JsonPatch

parseJSONList :: Value -> Parser [JsonPatch]

ToJSON JsonPatch

ToJSON JsonPatch

Defined in OryHydra.Model

Methods

toJSON :: JsonPatch -> Value

toEncoding :: JsonPatch -> Encoding

toJSONList :: [JsonPatch] -> Value

toEncodingList :: [JsonPatch] -> Encoding

Show JsonPatch

Defined in OryHydra.Model

Methods

showsPrec :: Int -> JsonPatch -> ShowS

show :: JsonPatch -> String

showList :: [JsonPatch] -> ShowS

Eq JsonPatch

Defined in OryHydra.Model

Methods

(==) :: JsonPatch -> JsonPatch -> Bool

(/=) :: JsonPatch -> JsonPatch -> Bool

mkJsonPatch

Arguments

:: Text

jsonPatchOp: The operation to be performed. One of "add", "remove", "replace", "move", "copy", or "test".

-> Text

jsonPatchPath: The path to the target path. Uses JSON pointer notation. Learn more about JSON Pointers.

-> JsonPatch

Construct a value of type JsonPatch (by applying it's required fields, if any)

JsonWebKey

data JsonWebKey

JsonWebKey

Constructors

JsonWebKey

Fields

• jsonWebKeyAlg :: Text

  Required "alg" - The "alg" (algorithm) parameter identifies the algorithm intended for use with the key. The values used should either be registered in the IANA "JSON Web Signature and Encryption Algorithms" registry established by [JWA] or be a value that contains a Collision- Resistant Name.

• jsonWebKeyCrv :: Maybe Text

  "crv"

• jsonWebKeyD :: Maybe Text

  "d"

• jsonWebKeyDp :: Maybe Text

  "dp"

• jsonWebKeyDq :: Maybe Text

  "dq"

• jsonWebKeyE :: Maybe Text

  "e"

• jsonWebKeyK :: Maybe Text

  "k"

• jsonWebKeyKid :: Text

  Required "kid" - The "kid" (key ID) parameter is used to match a specific key. This is used, for instance, to choose among a set of keys within a JWK Set during key rollover. The structure of the "kid" value is unspecified. When "kid" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct "kid" values. (One example in which different keys might use the same "kid" value is if they have different "kty" (key type) values but are considered to be equivalent alternatives by the application using them.) The "kid" value is a case-sensitive string.

• jsonWebKeyKty :: Text

  Required "kty" - The "kty" (key type) parameter identifies the cryptographic algorithm family used with the key, such as "RSA" or "EC". "kty" values should either be registered in the IANA "JSON Web Key Types" registry established by [JWA] or be a value that contains a Collision- Resistant Name. The "kty" value is a case-sensitive string.

• jsonWebKeyN :: Maybe Text

  "n"

• jsonWebKeyP :: Maybe Text

  "p"

• jsonWebKeyQ :: Maybe Text

  "q"

• jsonWebKeyQi :: Maybe Text

  "qi"

• jsonWebKeyUse :: Text

  Required "use" - Use ("public key use") identifies the intended use of the public key. The "use" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly "sig" (signature) or "enc" (encryption).

• jsonWebKeyX :: Maybe Text

  "x"

• jsonWebKeyX5c :: Maybe [Text]

  "x5c" - The "x5c" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate.

• jsonWebKeyY :: Maybe Text

  "y"

Instances

FromJSON JsonWebKey

FromJSON JsonWebKey

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser JsonWebKey

parseJSONList :: Value -> Parser [JsonWebKey]

ToJSON JsonWebKey

ToJSON JsonWebKey

Defined in OryHydra.Model

Methods

toJSON :: JsonWebKey -> Value

toEncoding :: JsonWebKey -> Encoding

toJSONList :: [JsonWebKey] -> Value

toEncodingList :: [JsonWebKey] -> Encoding

Show JsonWebKey

Defined in OryHydra.Model

Methods

showsPrec :: Int -> JsonWebKey -> ShowS

show :: JsonWebKey -> String

showList :: [JsonWebKey] -> ShowS

Eq JsonWebKey

Defined in OryHydra.Model

Methods

(==) :: JsonWebKey -> JsonWebKey -> Bool

(/=) :: JsonWebKey -> JsonWebKey -> Bool

HasBodyParam SetJsonWebKey JsonWebKey

Defined in OryHydra.API.Jwk

Methods

setBodyParam :: (Consumes SetJsonWebKey contentType, MimeRender contentType JsonWebKey) => OryHydraRequest SetJsonWebKey contentType res accept -> JsonWebKey -> OryHydraRequest SetJsonWebKey contentType res accept

mkJsonWebKey

Arguments

:: Text

jsonWebKeyAlg: The "alg" (algorithm) parameter identifies the algorithm intended for use with the key. The values used should either be registered in the IANA "JSON Web Signature and Encryption Algorithms" registry established by [JWA] or be a value that contains a Collision- Resistant Name.

-> Text

jsonWebKeyKid: The "kid" (key ID) parameter is used to match a specific key. This is used, for instance, to choose among a set of keys within a JWK Set during key rollover. The structure of the "kid" value is unspecified. When "kid" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct "kid" values. (One example in which different keys might use the same "kid" value is if they have different "kty" (key type) values but are considered to be equivalent alternatives by the application using them.) The "kid" value is a case-sensitive string.

-> Text

jsonWebKeyKty: The "kty" (key type) parameter identifies the cryptographic algorithm family used with the key, such as "RSA" or "EC". "kty" values should either be registered in the IANA "JSON Web Key Types" registry established by [JWA] or be a value that contains a Collision- Resistant Name. The "kty" value is a case-sensitive string.

-> Text

jsonWebKeyUse: Use ("public key use") identifies the intended use of the public key. The "use" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly "sig" (signature) or "enc" (encryption).

-> JsonWebKey

Construct a value of type JsonWebKey (by applying it's required fields, if any)

JsonWebKeySet

data JsonWebKeySet

JsonWebKeySet JSON Web Key Set

Constructors

JsonWebKeySet

Fields

• jsonWebKeySetKeys :: Maybe [JsonWebKey]

  "keys" - List of JSON Web Keys The value of the "keys" parameter is an array of JSON Web Key (JWK) values. By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired.

Instances

FromJSON JsonWebKeySet

FromJSON JsonWebKeySet

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser JsonWebKeySet

parseJSONList :: Value -> Parser [JsonWebKeySet]

ToJSON JsonWebKeySet

ToJSON JsonWebKeySet

Defined in OryHydra.Model

Methods

toJSON :: JsonWebKeySet -> Value

toEncoding :: JsonWebKeySet -> Encoding

toJSONList :: [JsonWebKeySet] -> Value

toEncodingList :: [JsonWebKeySet] -> Encoding

Show JsonWebKeySet

Defined in OryHydra.Model

Methods

showsPrec :: Int -> JsonWebKeySet -> ShowS

show :: JsonWebKeySet -> String

showList :: [JsonWebKeySet] -> ShowS

Eq JsonWebKeySet

Defined in OryHydra.Model

Methods

(==) :: JsonWebKeySet -> JsonWebKeySet -> Bool

(/=) :: JsonWebKeySet -> JsonWebKeySet -> Bool

HasBodyParam SetJsonWebKeySet JsonWebKeySet

Defined in OryHydra.API.Jwk

Methods

setBodyParam :: (Consumes SetJsonWebKeySet contentType, MimeRender contentType JsonWebKeySet) => OryHydraRequest SetJsonWebKeySet contentType res accept -> JsonWebKeySet -> OryHydraRequest SetJsonWebKeySet contentType res accept

mkJsonWebKeySet :: JsonWebKeySet

Construct a value of type JsonWebKeySet (by applying it's required fields, if any)

OAuth2Client

data OAuth2Client

OAuth2Client OAuth 2.0 Client

OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.

Constructors

OAuth2Client

Fields

• oAuth2ClientAllowedCorsOrigins :: Maybe [Text]

  "allowed_cors_origins"

• oAuth2ClientAudience :: Maybe [Text]

  "audience"

• oAuth2ClientAuthorizationCodeGrantAccessTokenLifespan :: Maybe Text

  "authorization_code_grant_access_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientAuthorizationCodeGrantIdTokenLifespan :: Maybe Text

  "authorization_code_grant_id_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientAuthorizationCodeGrantRefreshTokenLifespan :: Maybe Text

  "authorization_code_grant_refresh_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientBackchannelLogoutSessionRequired :: Maybe Bool

  "backchannel_logout_session_required" - OpenID Connect Back-Channel Logout Session Required Boolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false.

• oAuth2ClientBackchannelLogoutUri :: Maybe Text

  "backchannel_logout_uri" - OpenID Connect Back-Channel Logout URI RP URL that will cause the RP to log itself out when sent a Logout Token by the OP.

• oAuth2ClientClientCredentialsGrantAccessTokenLifespan :: Maybe Text

  "client_credentials_grant_access_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientClientId :: Maybe Text

  "client_id" - OAuth 2.0 Client ID The ID is autogenerated and immutable.

• oAuth2ClientClientName :: Maybe Text

  "client_name" - OAuth 2.0 Client Name The human-readable name of the client to be presented to the end-user during authorization.

• oAuth2ClientClientSecret :: Maybe Text

  "client_secret" - OAuth 2.0 Client Secret The secret will be included in the create request as cleartext, and then never again. The secret is kept in hashed format and is not recoverable once lost.

• oAuth2ClientClientSecretExpiresAt :: Maybe Integer

  "client_secret_expires_at" - OAuth 2.0 Client Secret Expires At The field is currently not supported and its value is always 0.

• oAuth2ClientClientUri :: Maybe Text

  "client_uri" - OAuth 2.0 Client URI ClientURI is a URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion.

• oAuth2ClientContacts :: Maybe [Text]

  "contacts"

• oAuth2ClientCreatedAt :: Maybe DateTime

  "created_at" - OAuth 2.0 Client Creation Date CreatedAt returns the timestamp of the client's creation.

• oAuth2ClientFrontchannelLogoutSessionRequired :: Maybe Bool

  "frontchannel_logout_session_required" - OpenID Connect Front-Channel Logout Session Required Boolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false.

• oAuth2ClientFrontchannelLogoutUri :: Maybe Text

  "frontchannel_logout_uri" - OpenID Connect Front-Channel Logout URI RP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be.

• oAuth2ClientGrantTypes :: Maybe [Text]

  "grant_types"

• oAuth2ClientImplicitGrantAccessTokenLifespan :: Maybe Text

  "implicit_grant_access_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientImplicitGrantIdTokenLifespan :: Maybe Text

  "implicit_grant_id_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientJwks :: Maybe Value

  "jwks" - OAuth 2.0 Client JSON Web Key Set Client's JSON Web Key Set [JWK] document, passed by value. The semantics of the jwks parameter are the same as the jwks_uri parameter, other than that the JWK Set is passed by value, rather than by reference. This parameter is intended only to be used by Clients that, for some reason, are unable to use the jwks_uri parameter, for instance, by native applications that might not have a location to host the contents of the JWK Set. If a Client can use jwks_uri, it MUST NOT use jwks. One significant downside of jwks is that it does not enable key rotation (which jwks_uri does, as described in Section 10 of OpenID Connect Core 1.0 [OpenID.Core]). The jwks_uri and jwks parameters MUST NOT be used together.

• oAuth2ClientJwksUri :: Maybe Text

  "jwks_uri" - OAuth 2.0 Client JSON Web Key Set URL URL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.

• oAuth2ClientJwtBearerGrantAccessTokenLifespan :: Maybe Text

  "jwt_bearer_grant_access_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientLogoUri :: Maybe Text

  "logo_uri" - OAuth 2.0 Client Logo URI A URL string referencing the client's logo.

• oAuth2ClientMetadata :: Maybe Value

  "metadata"

• oAuth2ClientOwner :: Maybe Text

  "owner" - OAuth 2.0 Client Owner Owner is a string identifying the owner of the OAuth 2.0 Client.

• oAuth2ClientPolicyUri :: Maybe Text

  "policy_uri" - OAuth 2.0 Client Policy URI PolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.

• oAuth2ClientPostLogoutRedirectUris :: Maybe [Text]

  "post_logout_redirect_uris"

• oAuth2ClientRedirectUris :: Maybe [Text]

  "redirect_uris"

• oAuth2ClientRefreshTokenGrantAccessTokenLifespan :: Maybe Text

  "refresh_token_grant_access_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientRefreshTokenGrantIdTokenLifespan :: Maybe Text

  "refresh_token_grant_id_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientRefreshTokenGrantRefreshTokenLifespan :: Maybe Text

  "refresh_token_grant_refresh_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientRegistrationAccessToken :: Maybe Text

  "registration_access_token" - OpenID Connect Dynamic Client Registration Access Token RegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client using Dynamic Client Registration.

• oAuth2ClientRegistrationClientUri :: Maybe Text

  "registration_client_uri" - OpenID Connect Dynamic Client Registration URL RegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.

• oAuth2ClientRequestObjectSigningAlg :: Maybe Text

  "request_object_signing_alg" - OpenID Connect Request Object Signing Algorithm JWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm.

• oAuth2ClientRequestUris :: Maybe [Text]

  "request_uris"

• oAuth2ClientResponseTypes :: Maybe [Text]

  "response_types"

• oAuth2ClientScope :: Maybe Text

  "scope" - OAuth 2.0 Client Scope Scope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens.

• oAuth2ClientSectorIdentifierUri :: Maybe Text

  "sector_identifier_uri" - OpenID Connect Sector Identifier URI URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values.

• oAuth2ClientSubjectType :: Maybe Text

  "subject_type" - OpenID Connect Subject Type The `subject_types_supported` Discovery parameter contains a list of the supported subject_type values for this server. Valid types include `pairwise` and `public`.

• oAuth2ClientTokenEndpointAuthMethod :: Maybe Text

  "token_endpoint_auth_method" - OAuth 2.0 Token Endpoint Authentication Method Requested Client Authentication method for the Token Endpoint. The options are: `client_secret_post`: (default) Send `client_id` and `client_secret` as `applicationx-www-form-urlencoded` in the HTTP body. `client_secret_basic`: Send `client_id` and `client_secret` as `applicationx-www-form-urlencoded` encoded in the HTTP Authorization header. `private_key_jwt`: Use JSON Web Tokens to authenticate the client. `none`: Used for public clients (native apps, mobile apps) which can not have secrets.

• oAuth2ClientTokenEndpointAuthSigningAlg :: Maybe Text

  "token_endpoint_auth_signing_alg" - OAuth 2.0 Token Endpoint Signing Algorithm Requested Client Authentication signing algorithm for the Token Endpoint.

• oAuth2ClientTosUri :: Maybe Text

  "tos_uri" - OAuth 2.0 Client Terms of Service URI A URL string pointing to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.

• oAuth2ClientUpdatedAt :: Maybe DateTime

  "updated_at" - OAuth 2.0 Client Last Update Date UpdatedAt returns the timestamp of the last update.

• oAuth2ClientUserinfoSignedResponseAlg :: Maybe Text

  "userinfo_signed_response_alg" - OpenID Connect Request Userinfo Signed Response Algorithm JWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type.

Instances

FromJSON OAuth2Client

FromJSON OAuth2Client

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser OAuth2Client

parseJSONList :: Value -> Parser [OAuth2Client]

ToJSON OAuth2Client

ToJSON OAuth2Client

Defined in OryHydra.Model

Methods

toJSON :: OAuth2Client -> Value

toEncoding :: OAuth2Client -> Encoding

toJSONList :: [OAuth2Client] -> Value

toEncodingList :: [OAuth2Client] -> Encoding

Show OAuth2Client

Defined in OryHydra.Model

Methods

showsPrec :: Int -> OAuth2Client -> ShowS

show :: OAuth2Client -> String

showList :: [OAuth2Client] -> ShowS

Eq OAuth2Client

Defined in OryHydra.Model

Methods

(==) :: OAuth2Client -> OAuth2Client -> Bool

(/=) :: OAuth2Client -> OAuth2Client -> Bool

HasBodyParam CreateOAuth2Client OAuth2Client

Body Param OAuth2Client - OAuth 2.0 Client Request Body

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes CreateOAuth2Client contentType, MimeRender contentType OAuth2Client) => OryHydraRequest CreateOAuth2Client contentType res accept -> OAuth2Client -> OryHydraRequest CreateOAuth2Client contentType res accept

HasBodyParam SetOAuth2Client OAuth2Client

Body Param OAuth2Client - OAuth 2.0 Client Request Body

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes SetOAuth2Client contentType, MimeRender contentType OAuth2Client) => OryHydraRequest SetOAuth2Client contentType res accept -> OAuth2Client -> OryHydraRequest SetOAuth2Client contentType res accept

HasBodyParam CreateOidcDynamicClient OAuth2Client

Body Param OAuth2Client - Dynamic Client Registration Request Body

Defined in OryHydra.API.Oidc

Methods

setBodyParam :: (Consumes CreateOidcDynamicClient contentType, MimeRender contentType OAuth2Client) => OryHydraRequest CreateOidcDynamicClient contentType res accept -> OAuth2Client -> OryHydraRequest CreateOidcDynamicClient contentType res accept

HasBodyParam SetOidcDynamicClient OAuth2Client

Body Param OAuth2Client - OAuth 2.0 Client Request Body

Defined in OryHydra.API.Oidc

Methods

setBodyParam :: (Consumes SetOidcDynamicClient contentType, MimeRender contentType OAuth2Client) => OryHydraRequest SetOidcDynamicClient contentType res accept -> OAuth2Client -> OryHydraRequest SetOidcDynamicClient contentType res accept

mkOAuth2Client :: OAuth2Client

Construct a value of type OAuth2Client (by applying it's required fields, if any)

OAuth2ClientTokenLifespans

data OAuth2ClientTokenLifespans

OAuth2ClientTokenLifespans OAuth 2.0 Client Token Lifespans

Lifespans of different token types issued for this OAuth 2.0 Client.

Constructors

OAuth2ClientTokenLifespans

Fields

• oAuth2ClientTokenLifespansAuthorizationCodeGrantAccessTokenLifespan :: Maybe Text

  "authorization_code_grant_access_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientTokenLifespansAuthorizationCodeGrantIdTokenLifespan :: Maybe Text

  "authorization_code_grant_id_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientTokenLifespansAuthorizationCodeGrantRefreshTokenLifespan :: Maybe Text

  "authorization_code_grant_refresh_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientTokenLifespansClientCredentialsGrantAccessTokenLifespan :: Maybe Text

  "client_credentials_grant_access_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientTokenLifespansImplicitGrantAccessTokenLifespan :: Maybe Text

  "implicit_grant_access_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientTokenLifespansImplicitGrantIdTokenLifespan :: Maybe Text

  "implicit_grant_id_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientTokenLifespansJwtBearerGrantAccessTokenLifespan :: Maybe Text

  "jwt_bearer_grant_access_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientTokenLifespansRefreshTokenGrantAccessTokenLifespan :: Maybe Text

  "refresh_token_grant_access_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientTokenLifespansRefreshTokenGrantIdTokenLifespan :: Maybe Text

  "refresh_token_grant_id_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

• oAuth2ClientTokenLifespansRefreshTokenGrantRefreshTokenLifespan :: Maybe Text

  "refresh_token_grant_refresh_token_lifespan" - Specify a time duration in milliseconds, seconds, minutes, hours.

Instances

FromJSON OAuth2ClientTokenLifespans

FromJSON OAuth2ClientTokenLifespans

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser OAuth2ClientTokenLifespans

parseJSONList :: Value -> Parser [OAuth2ClientTokenLifespans]

ToJSON OAuth2ClientTokenLifespans

ToJSON OAuth2ClientTokenLifespans

Defined in OryHydra.Model

Methods

toJSON :: OAuth2ClientTokenLifespans -> Value

toEncoding :: OAuth2ClientTokenLifespans -> Encoding

toJSONList :: [OAuth2ClientTokenLifespans] -> Value

toEncodingList :: [OAuth2ClientTokenLifespans] -> Encoding

Show OAuth2ClientTokenLifespans

Defined in OryHydra.Model

Methods

showsPrec :: Int -> OAuth2ClientTokenLifespans -> ShowS

show :: OAuth2ClientTokenLifespans -> String

showList :: [OAuth2ClientTokenLifespans] -> ShowS

Eq OAuth2ClientTokenLifespans

Defined in OryHydra.Model

Methods

(==) :: OAuth2ClientTokenLifespans -> OAuth2ClientTokenLifespans -> Bool

(/=) :: OAuth2ClientTokenLifespans -> OAuth2ClientTokenLifespans -> Bool

HasBodyParam SetOAuth2ClientLifespans OAuth2ClientTokenLifespans

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes SetOAuth2ClientLifespans contentType, MimeRender contentType OAuth2ClientTokenLifespans) => OryHydraRequest SetOAuth2ClientLifespans contentType res accept -> OAuth2ClientTokenLifespans -> OryHydraRequest SetOAuth2ClientLifespans contentType res accept

mkOAuth2ClientTokenLifespans :: OAuth2ClientTokenLifespans

Construct a value of type OAuth2ClientTokenLifespans (by applying it's required fields, if any)

OAuth2ConsentRequest

data OAuth2ConsentRequest

OAuth2ConsentRequest Contains information on an ongoing consent request.

Constructors

OAuth2ConsentRequest

Fields

• oAuth2ConsentRequestAcr :: Maybe Text

  "acr" - ACR represents the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication.

• oAuth2ConsentRequestAmr :: Maybe [Text]

  "amr"

• oAuth2ConsentRequestChallenge :: Text

  Required "challenge" - ID is the identifier ("authorization challenge") of the consent authorization request. It is used to identify the session.

• oAuth2ConsentRequestClient :: Maybe OAuth2Client

  "client"

• oAuth2ConsentRequestContext :: Maybe Value

  "context"

• oAuth2ConsentRequestLoginChallenge :: Maybe Text

  "login_challenge" - LoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate a login and consent request in the login & consent app.

• oAuth2ConsentRequestLoginSessionId :: Maybe Text

  "login_session_id" - LoginSessionID is the login session ID. If the user-agent reuses a login session (via cookie remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC Front-Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user.

• oAuth2ConsentRequestOidcContext :: Maybe OAuth2ConsentRequestOpenIDConnectContext

  "oidc_context"

• oAuth2ConsentRequestRequestUrl :: Maybe Text

  "request_url" - RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.

• oAuth2ConsentRequestRequestedAccessTokenAudience :: Maybe [Text]

  "requested_access_token_audience"

• oAuth2ConsentRequestRequestedScope :: Maybe [Text]

  "requested_scope"

• oAuth2ConsentRequestSkip :: Maybe Bool

  "skip" - Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you must not ask the user to grant the requested scopes. You must however either allow or deny the consent request using the usual API call.

• oAuth2ConsentRequestSubject :: Maybe Text

  "subject" - Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client.

Instances

FromJSON OAuth2ConsentRequest

FromJSON OAuth2ConsentRequest

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser OAuth2ConsentRequest

parseJSONList :: Value -> Parser [OAuth2ConsentRequest]

ToJSON OAuth2ConsentRequest

ToJSON OAuth2ConsentRequest

Defined in OryHydra.Model

Methods

toJSON :: OAuth2ConsentRequest -> Value

toEncoding :: OAuth2ConsentRequest -> Encoding

toJSONList :: [OAuth2ConsentRequest] -> Value

toEncodingList :: [OAuth2ConsentRequest] -> Encoding

Show OAuth2ConsentRequest

Defined in OryHydra.Model

Methods

showsPrec :: Int -> OAuth2ConsentRequest -> ShowS

show :: OAuth2ConsentRequest -> String

showList :: [OAuth2ConsentRequest] -> ShowS

Eq OAuth2ConsentRequest

Defined in OryHydra.Model

Methods

(==) :: OAuth2ConsentRequest -> OAuth2ConsentRequest -> Bool

(/=) :: OAuth2ConsentRequest -> OAuth2ConsentRequest -> Bool

mkOAuth2ConsentRequest

Arguments

:: Text

oAuth2ConsentRequestChallenge: ID is the identifier ("authorization challenge") of the consent authorization request. It is used to identify the session.

-> OAuth2ConsentRequest

Construct a value of type OAuth2ConsentRequest (by applying it's required fields, if any)

OAuth2ConsentRequestOpenIDConnectContext

data OAuth2ConsentRequestOpenIDConnectContext

OAuth2ConsentRequestOpenIDConnectContext Contains optional information about the OpenID Connect request.

Constructors

OAuth2ConsentRequestOpenIDConnectContext

Fields

• oAuth2ConsentRequestOpenIDConnectContextAcrValues :: Maybe [Text]

  "acr_values" - ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request. It is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required. OpenID Connect defines it as follows: > Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication performed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a Voluntary Claim by this parameter.

• oAuth2ConsentRequestOpenIDConnectContextDisplay :: Maybe Text

  "display" - Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User. The defined values are: page: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode. popup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over. touch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface. wap: The Authorization Server SHOULD display the authentication and consent UI consistent with a "feature phone" type display. The Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.

• oAuth2ConsentRequestOpenIDConnectContextIdTokenHintClaims :: Maybe (Map String Value)

  "id_token_hint_claims" - IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the End-User's current or past authenticated session with the Client.

• oAuth2ConsentRequestOpenIDConnectContextLoginHint :: Maybe Text

  "login_hint" - LoginHint hints about the login identifier the End-User might use to log in (if necessary). This hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier) and then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a phone number in the format specified for the phone_number Claim. The use of this parameter is optional.

• oAuth2ConsentRequestOpenIDConnectContextUiLocales :: Maybe [Text]

  "ui_locales" - UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value "fr-CA fr en" represents a preference for French as spoken in Canada, then French (without a region designation), followed by English (without a region designation). An error SHOULD NOT result if some or all of the requested locales are not supported by the OpenID Provider.

Instances

FromJSON OAuth2ConsentRequestOpenIDConnectContext

FromJSON OAuth2ConsentRequestOpenIDConnectContext

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser OAuth2ConsentRequestOpenIDConnectContext

parseJSONList :: Value -> Parser [OAuth2ConsentRequestOpenIDConnectContext]

ToJSON OAuth2ConsentRequestOpenIDConnectContext

ToJSON OAuth2ConsentRequestOpenIDConnectContext

Defined in OryHydra.Model

Methods

toJSON :: OAuth2ConsentRequestOpenIDConnectContext -> Value

toEncoding :: OAuth2ConsentRequestOpenIDConnectContext -> Encoding

toJSONList :: [OAuth2ConsentRequestOpenIDConnectContext] -> Value

toEncodingList :: [OAuth2ConsentRequestOpenIDConnectContext] -> Encoding

Show OAuth2ConsentRequestOpenIDConnectContext

Defined in OryHydra.Model

Methods

showsPrec :: Int -> OAuth2ConsentRequestOpenIDConnectContext -> ShowS

show :: OAuth2ConsentRequestOpenIDConnectContext -> String

showList :: [OAuth2ConsentRequestOpenIDConnectContext] -> ShowS

Eq OAuth2ConsentRequestOpenIDConnectContext

Defined in OryHydra.Model

Methods

(==) :: OAuth2ConsentRequestOpenIDConnectContext -> OAuth2ConsentRequestOpenIDConnectContext -> Bool

(/=) :: OAuth2ConsentRequestOpenIDConnectContext -> OAuth2ConsentRequestOpenIDConnectContext -> Bool

mkOAuth2ConsentRequestOpenIDConnectContext :: OAuth2ConsentRequestOpenIDConnectContext

Construct a value of type OAuth2ConsentRequestOpenIDConnectContext (by applying it's required fields, if any)

OAuth2ConsentSession

data OAuth2ConsentSession

OAuth2ConsentSession OAuth 2.0 Consent Session

A completed OAuth 2.0 Consent Session.

Constructors

OAuth2ConsentSession

Fields

• oAuth2ConsentSessionConsentRequest :: Maybe OAuth2ConsentRequest

  "consent_request"

• oAuth2ConsentSessionExpiresAt :: Maybe OAuth2ConsentSessionExpiresAt

  "expires_at"

• oAuth2ConsentSessionGrantAccessTokenAudience :: Maybe [Text]

  "grant_access_token_audience"

• oAuth2ConsentSessionGrantScope :: Maybe [Text]

  "grant_scope"

• oAuth2ConsentSessionHandledAt :: Maybe DateTime

  "handled_at"

• oAuth2ConsentSessionRemember :: Maybe Bool

  "remember" - Remember Consent Remember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same client asks the same user for the same, or a subset of, scope.

• oAuth2ConsentSessionRememberFor :: Maybe Integer

  "remember_for" - Remember Consent For RememberFor sets how long the consent authorization should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely.

• oAuth2ConsentSessionSession :: Maybe AcceptOAuth2ConsentRequestSession

  "session"

Instances

FromJSON OAuth2ConsentSession

FromJSON OAuth2ConsentSession

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser OAuth2ConsentSession

parseJSONList :: Value -> Parser [OAuth2ConsentSession]

ToJSON OAuth2ConsentSession

ToJSON OAuth2ConsentSession

Defined in OryHydra.Model

Methods

toJSON :: OAuth2ConsentSession -> Value

toEncoding :: OAuth2ConsentSession -> Encoding

toJSONList :: [OAuth2ConsentSession] -> Value

toEncodingList :: [OAuth2ConsentSession] -> Encoding

Show OAuth2ConsentSession

Defined in OryHydra.Model

Methods

showsPrec :: Int -> OAuth2ConsentSession -> ShowS

show :: OAuth2ConsentSession -> String

showList :: [OAuth2ConsentSession] -> ShowS

Eq OAuth2ConsentSession

Defined in OryHydra.Model

Methods

(==) :: OAuth2ConsentSession -> OAuth2ConsentSession -> Bool

(/=) :: OAuth2ConsentSession -> OAuth2ConsentSession -> Bool

mkOAuth2ConsentSession :: OAuth2ConsentSession

Construct a value of type OAuth2ConsentSession (by applying it's required fields, if any)

OAuth2ConsentSessionExpiresAt

data OAuth2ConsentSessionExpiresAt

OAuth2ConsentSessionExpiresAt

Constructors

OAuth2ConsentSessionExpiresAt

Fields

• oAuth2ConsentSessionExpiresAtAccessToken :: Maybe DateTime

  "access_token"

• oAuth2ConsentSessionExpiresAtAuthorizeCode :: Maybe DateTime

  "authorize_code"

• oAuth2ConsentSessionExpiresAtIdToken :: Maybe DateTime

  "id_token"

• oAuth2ConsentSessionExpiresAtParContext :: Maybe DateTime

  "par_context"

• oAuth2ConsentSessionExpiresAtRefreshToken :: Maybe DateTime

  "refresh_token"

Instances

FromJSON OAuth2ConsentSessionExpiresAt

FromJSON OAuth2ConsentSessionExpiresAt

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser OAuth2ConsentSessionExpiresAt

parseJSONList :: Value -> Parser [OAuth2ConsentSessionExpiresAt]

ToJSON OAuth2ConsentSessionExpiresAt

ToJSON OAuth2ConsentSessionExpiresAt

Defined in OryHydra.Model

Methods

toJSON :: OAuth2ConsentSessionExpiresAt -> Value

toEncoding :: OAuth2ConsentSessionExpiresAt -> Encoding

toJSONList :: [OAuth2ConsentSessionExpiresAt] -> Value

toEncodingList :: [OAuth2ConsentSessionExpiresAt] -> Encoding

Show OAuth2ConsentSessionExpiresAt

Defined in OryHydra.Model

Methods

showsPrec :: Int -> OAuth2ConsentSessionExpiresAt -> ShowS

show :: OAuth2ConsentSessionExpiresAt -> String

showList :: [OAuth2ConsentSessionExpiresAt] -> ShowS

Eq OAuth2ConsentSessionExpiresAt

Defined in OryHydra.Model

Methods

(==) :: OAuth2ConsentSessionExpiresAt -> OAuth2ConsentSessionExpiresAt -> Bool

(/=) :: OAuth2ConsentSessionExpiresAt -> OAuth2ConsentSessionExpiresAt -> Bool

mkOAuth2ConsentSessionExpiresAt :: OAuth2ConsentSessionExpiresAt

Construct a value of type OAuth2ConsentSessionExpiresAt (by applying it's required fields, if any)

OAuth2LoginRequest

data OAuth2LoginRequest

OAuth2LoginRequest Contains information on an ongoing login request.

Constructors

OAuth2LoginRequest

Fields

• oAuth2LoginRequestChallenge :: Text

  Required "challenge" - ID is the identifier ("login challenge") of the login request. It is used to identify the session.

• oAuth2LoginRequestClient :: OAuth2Client

  Required "client"

• oAuth2LoginRequestOidcContext :: Maybe OAuth2ConsentRequestOpenIDConnectContext

  "oidc_context"

• oAuth2LoginRequestRequestUrl :: Text

  Required "request_url" - RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.

• oAuth2LoginRequestRequestedAccessTokenAudience :: [Text]

  Required "requested_access_token_audience"

• oAuth2LoginRequestRequestedScope :: [Text]

  Required "requested_scope"

• oAuth2LoginRequestSessionId :: Maybe Text

  "session_id" - SessionID is the login session ID. If the user-agent reuses a login session (via cookie remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC Front-Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user.

• oAuth2LoginRequestSkip :: Bool

  Required "skip" - Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL. This feature allows you to update / set session information.

• oAuth2LoginRequestSubject :: Text

  Required "subject" - Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type when accepting the login request, or the request will fail.

Instances

FromJSON OAuth2LoginRequest

FromJSON OAuth2LoginRequest

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser OAuth2LoginRequest

parseJSONList :: Value -> Parser [OAuth2LoginRequest]

ToJSON OAuth2LoginRequest

ToJSON OAuth2LoginRequest

Defined in OryHydra.Model

Methods

toJSON :: OAuth2LoginRequest -> Value

toEncoding :: OAuth2LoginRequest -> Encoding

toJSONList :: [OAuth2LoginRequest] -> Value

toEncodingList :: [OAuth2LoginRequest] -> Encoding

Show OAuth2LoginRequest

Defined in OryHydra.Model

Methods

showsPrec :: Int -> OAuth2LoginRequest -> ShowS

show :: OAuth2LoginRequest -> String

showList :: [OAuth2LoginRequest] -> ShowS

Eq OAuth2LoginRequest

Defined in OryHydra.Model

Methods

(==) :: OAuth2LoginRequest -> OAuth2LoginRequest -> Bool

(/=) :: OAuth2LoginRequest -> OAuth2LoginRequest -> Bool

mkOAuth2LoginRequest

Arguments

:: Text

oAuth2LoginRequestChallenge: ID is the identifier ("login challenge") of the login request. It is used to identify the session.

-> OAuth2Client

oAuth2LoginRequestClient

-> Text

oAuth2LoginRequestRequestUrl: RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.

-> [Text]

oAuth2LoginRequestRequestedAccessTokenAudience

-> [Text]

oAuth2LoginRequestRequestedScope

-> Bool

oAuth2LoginRequestSkip: Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL. This feature allows you to update / set session information.

-> Text

oAuth2LoginRequestSubject: Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client. If this value is set and skip is true, you MUST include this subject type when accepting the login request, or the request will fail.

-> OAuth2LoginRequest

Construct a value of type OAuth2LoginRequest (by applying it's required fields, if any)

OAuth2LogoutRequest

data OAuth2LogoutRequest

OAuth2LogoutRequest Contains information about an ongoing logout request.

Constructors

OAuth2LogoutRequest

Fields

• oAuth2LogoutRequestChallenge :: Maybe Text

  "challenge" - Challenge is the identifier ("logout challenge") of the logout authentication request. It is used to identify the session.

• oAuth2LogoutRequestClient :: Maybe OAuth2Client

  "client"

• oAuth2LogoutRequestRequestUrl :: Maybe Text

  "request_url" - RequestURL is the original Logout URL requested.

• oAuth2LogoutRequestRpInitiated :: Maybe Bool

  "rp_initiated" - RPInitiated is set to true if the request was initiated by a Relying Party (RP), also known as an OAuth 2.0 Client.

• oAuth2LogoutRequestSid :: Maybe Text

  "sid" - SessionID is the login session ID that was requested to log out.

• oAuth2LogoutRequestSubject :: Maybe Text

  "subject" - Subject is the user for whom the logout was request.

Instances

FromJSON OAuth2LogoutRequest

FromJSON OAuth2LogoutRequest

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser OAuth2LogoutRequest

parseJSONList :: Value -> Parser [OAuth2LogoutRequest]

ToJSON OAuth2LogoutRequest

ToJSON OAuth2LogoutRequest

Defined in OryHydra.Model

Methods

toJSON :: OAuth2LogoutRequest -> Value

toEncoding :: OAuth2LogoutRequest -> Encoding

toJSONList :: [OAuth2LogoutRequest] -> Value

toEncodingList :: [OAuth2LogoutRequest] -> Encoding

Show OAuth2LogoutRequest

Defined in OryHydra.Model

Methods

showsPrec :: Int -> OAuth2LogoutRequest -> ShowS

show :: OAuth2LogoutRequest -> String

showList :: [OAuth2LogoutRequest] -> ShowS

Eq OAuth2LogoutRequest

Defined in OryHydra.Model

Methods

(==) :: OAuth2LogoutRequest -> OAuth2LogoutRequest -> Bool

(/=) :: OAuth2LogoutRequest -> OAuth2LogoutRequest -> Bool

mkOAuth2LogoutRequest :: OAuth2LogoutRequest

Construct a value of type OAuth2LogoutRequest (by applying it's required fields, if any)

OAuth2RedirectTo

data OAuth2RedirectTo

OAuth2RedirectTo OAuth 2.0 Redirect Browser To

Contains a redirect URL used to complete a login, consent, or logout request.

Constructors

OAuth2RedirectTo

Fields

• oAuth2RedirectToRedirectTo :: Text

  Required "redirect_to" - RedirectURL is the URL which you should redirect the user's browser to once the authentication process is completed.

Instances

FromJSON OAuth2RedirectTo

FromJSON OAuth2RedirectTo

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser OAuth2RedirectTo

parseJSONList :: Value -> Parser [OAuth2RedirectTo]

ToJSON OAuth2RedirectTo

ToJSON OAuth2RedirectTo

Defined in OryHydra.Model

Methods

toJSON :: OAuth2RedirectTo -> Value

toEncoding :: OAuth2RedirectTo -> Encoding

toJSONList :: [OAuth2RedirectTo] -> Value

toEncodingList :: [OAuth2RedirectTo] -> Encoding

Show OAuth2RedirectTo

Defined in OryHydra.Model

Methods

showsPrec :: Int -> OAuth2RedirectTo -> ShowS

show :: OAuth2RedirectTo -> String

showList :: [OAuth2RedirectTo] -> ShowS

Eq OAuth2RedirectTo

Defined in OryHydra.Model

Methods

(==) :: OAuth2RedirectTo -> OAuth2RedirectTo -> Bool

(/=) :: OAuth2RedirectTo -> OAuth2RedirectTo -> Bool

mkOAuth2RedirectTo

Arguments

:: Text

oAuth2RedirectToRedirectTo: RedirectURL is the URL which you should redirect the user's browser to once the authentication process is completed.

-> OAuth2RedirectTo

Construct a value of type OAuth2RedirectTo (by applying it's required fields, if any)

OAuth2TokenExchange

data OAuth2TokenExchange

OAuth2TokenExchange OAuth2 Token Exchange Result

Constructors

OAuth2TokenExchange

Fields

• oAuth2TokenExchangeAccessToken :: Maybe Text

  "access_token" - The access token issued by the authorization server.

• oAuth2TokenExchangeExpiresIn :: Maybe Integer

  "expires_in" - The lifetime in seconds of the access token. For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated.

• oAuth2TokenExchangeIdToken :: Maybe Integer

  "id_token" - To retrieve a refresh token request the id_token scope.

• oAuth2TokenExchangeRefreshToken :: Maybe Text

  "refresh_token" - The refresh token, which can be used to obtain new access tokens. To retrieve it add the scope "offline" to your access token request.

• oAuth2TokenExchangeScope :: Maybe Text

  "scope" - The scope of the access token

• oAuth2TokenExchangeTokenType :: Maybe Text

  "token_type" - The type of the token issued

Instances

FromJSON OAuth2TokenExchange

FromJSON OAuth2TokenExchange

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser OAuth2TokenExchange

parseJSONList :: Value -> Parser [OAuth2TokenExchange]

ToJSON OAuth2TokenExchange

ToJSON OAuth2TokenExchange

Defined in OryHydra.Model

Methods

toJSON :: OAuth2TokenExchange -> Value

toEncoding :: OAuth2TokenExchange -> Encoding

toJSONList :: [OAuth2TokenExchange] -> Value

toEncodingList :: [OAuth2TokenExchange] -> Encoding

Show OAuth2TokenExchange

Defined in OryHydra.Model

Methods

showsPrec :: Int -> OAuth2TokenExchange -> ShowS

show :: OAuth2TokenExchange -> String

showList :: [OAuth2TokenExchange] -> ShowS

Eq OAuth2TokenExchange

Defined in OryHydra.Model

Methods

(==) :: OAuth2TokenExchange -> OAuth2TokenExchange -> Bool

(/=) :: OAuth2TokenExchange -> OAuth2TokenExchange -> Bool

mkOAuth2TokenExchange :: OAuth2TokenExchange

Construct a value of type OAuth2TokenExchange (by applying it's required fields, if any)

OidcConfiguration

data OidcConfiguration

OidcConfiguration OpenID Connect Discovery Metadata

Includes links to several endpoints (for example `oauth2token`) and exposes information on supported signature algorithms among others.

Constructors

OidcConfiguration

Fields

• oidcConfigurationAuthorizationEndpoint :: Text

  Required "authorization_endpoint" - OAuth 2.0 Authorization Endpoint URL

• oidcConfigurationBackchannelLogoutSessionSupported :: Maybe Bool

  "backchannel_logout_session_supported" - OpenID Connect Back-Channel Logout Session Required Boolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to identify the RP session with the OP. If supported, the sid Claim is also included in ID Tokens issued by the OP

• oidcConfigurationBackchannelLogoutSupported :: Maybe Bool

  "backchannel_logout_supported" - OpenID Connect Back-Channel Logout Supported Boolean value specifying whether the OP supports back-channel logout, with true indicating support.

• oidcConfigurationClaimsParameterSupported :: Maybe Bool

  "claims_parameter_supported" - OpenID Connect Claims Parameter Parameter Supported Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support.

• oidcConfigurationClaimsSupported :: Maybe [Text]

  "claims_supported" - OpenID Connect Supported Claims JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list.

• oidcConfigurationCodeChallengeMethodsSupported :: Maybe [Text]

  "code_challenge_methods_supported" - OAuth 2.0 PKCE Supported Code Challenge Methods JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported by this authorization server.

• oidcConfigurationEndSessionEndpoint :: Maybe Text

  "end_session_endpoint" - OpenID Connect End-Session Endpoint URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP.

• oidcConfigurationFrontchannelLogoutSessionSupported :: Maybe Bool

  "frontchannel_logout_session_supported" - OpenID Connect Front-Channel Logout Session Required Boolean value specifying whether the OP can pass iss (issuer) and sid (session ID) query parameters to identify the RP session with the OP when the frontchannel_logout_uri is used. If supported, the sid Claim is also included in ID Tokens issued by the OP.

• oidcConfigurationFrontchannelLogoutSupported :: Maybe Bool

  "frontchannel_logout_supported" - OpenID Connect Front-Channel Logout Supported Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support.

• oidcConfigurationGrantTypesSupported :: Maybe [Text]

  "grant_types_supported" - OAuth 2.0 Supported Grant Types JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports.

• oidcConfigurationIdTokenSignedResponseAlg :: [Text]

  Required "id_token_signed_response_alg" - OpenID Connect Default ID Token Signing Algorithms Algorithm used to sign OpenID Connect ID Tokens.

• oidcConfigurationIdTokenSigningAlgValuesSupported :: [Text]

  Required "id_token_signing_alg_values_supported" - OpenID Connect Supported ID Token Signing Algorithms JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT.

• oidcConfigurationIssuer :: Text

  Required "issuer" - OpenID Connect Issuer URL An URL using the https scheme with no query or fragment component that the OP asserts as its IssuerURL Identifier. If IssuerURL discovery is supported , this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this IssuerURL.

• oidcConfigurationJwksUri :: Text

  Required "jwks_uri" - OpenID Connect Well-Known JSON Web Keys URL URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.

• oidcConfigurationRegistrationEndpoint :: Maybe Text

  "registration_endpoint" - OpenID Connect Dynamic Client Registration Endpoint URL

• oidcConfigurationRequestObjectSigningAlgValuesSupported :: Maybe [Text]

  "request_object_signing_alg_values_supported" - OpenID Connect Supported Request Object Signing Algorithms JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used both when the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter).

• oidcConfigurationRequestParameterSupported :: Maybe Bool

  "request_parameter_supported" - OpenID Connect Request Parameter Supported Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.

• oidcConfigurationRequestUriParameterSupported :: Maybe Bool

  "request_uri_parameter_supported" - OpenID Connect Request URI Parameter Supported Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.

• oidcConfigurationRequireRequestUriRegistration :: Maybe Bool

  "require_request_uri_registration" - OpenID Connect Requires Request URI Registration Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter.

• oidcConfigurationResponseModesSupported :: Maybe [Text]

  "response_modes_supported" - OAuth 2.0 Supported Response Modes JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.

• oidcConfigurationResponseTypesSupported :: [Text]

  Required "response_types_supported" - OAuth 2.0 Supported Response Types JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values.

• oidcConfigurationRevocationEndpoint :: Maybe Text

  "revocation_endpoint" - OAuth 2.0 Token Revocation URL URL of the authorization server's OAuth 2.0 revocation endpoint.

• oidcConfigurationScopesSupported :: Maybe [Text]

  "scopes_supported" - OAuth 2.0 Supported Scope Values JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used

• oidcConfigurationSubjectTypesSupported :: [Text]

  Required "subject_types_supported" - OpenID Connect Supported Subject Types JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public.

• oidcConfigurationTokenEndpoint :: Text

  Required "token_endpoint" - OAuth 2.0 Token Endpoint URL

• oidcConfigurationTokenEndpointAuthMethodsSupported :: Maybe [Text]

  "token_endpoint_auth_methods_supported" - OAuth 2.0 Supported Client Authentication Methods JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core 1.0

• oidcConfigurationUserinfoEndpoint :: Maybe Text

  "userinfo_endpoint" - OpenID Connect Userinfo URL URL of the OP's UserInfo Endpoint.

• oidcConfigurationUserinfoSignedResponseAlg :: [Text]

  Required "userinfo_signed_response_alg" - OpenID Connect User Userinfo Signing Algorithm Algorithm used to sign OpenID Connect Userinfo Responses.

• oidcConfigurationUserinfoSigningAlgValuesSupported :: Maybe [Text]

  "userinfo_signing_alg_values_supported" - OpenID Connect Supported Userinfo Signing Algorithm JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].

Instances

FromJSON OidcConfiguration

FromJSON OidcConfiguration

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser OidcConfiguration

parseJSONList :: Value -> Parser [OidcConfiguration]

ToJSON OidcConfiguration

ToJSON OidcConfiguration

Defined in OryHydra.Model

Methods

toJSON :: OidcConfiguration -> Value

toEncoding :: OidcConfiguration -> Encoding

toJSONList :: [OidcConfiguration] -> Value

toEncodingList :: [OidcConfiguration] -> Encoding

Show OidcConfiguration

Defined in OryHydra.Model

Methods

showsPrec :: Int -> OidcConfiguration -> ShowS

show :: OidcConfiguration -> String

showList :: [OidcConfiguration] -> ShowS

Eq OidcConfiguration

Defined in OryHydra.Model

Methods

(==) :: OidcConfiguration -> OidcConfiguration -> Bool

(/=) :: OidcConfiguration -> OidcConfiguration -> Bool

mkOidcConfiguration

Arguments

:: Text

oidcConfigurationAuthorizationEndpoint: OAuth 2.0 Authorization Endpoint URL

-> [Text]

oidcConfigurationIdTokenSignedResponseAlg: OpenID Connect Default ID Token Signing Algorithms Algorithm used to sign OpenID Connect ID Tokens.

-> [Text]

oidcConfigurationIdTokenSigningAlgValuesSupported: OpenID Connect Supported ID Token Signing Algorithms JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT.

-> Text

oidcConfigurationIssuer: OpenID Connect Issuer URL An URL using the https scheme with no query or fragment component that the OP asserts as its IssuerURL Identifier. If IssuerURL discovery is supported , this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this IssuerURL.

-> Text

oidcConfigurationJwksUri: OpenID Connect Well-Known JSON Web Keys URL URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.

-> [Text]

oidcConfigurationResponseTypesSupported: OAuth 2.0 Supported Response Types JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values.

-> [Text]

oidcConfigurationSubjectTypesSupported: OpenID Connect Supported Subject Types JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public.

-> Text

oidcConfigurationTokenEndpoint: OAuth 2.0 Token Endpoint URL

-> [Text]

oidcConfigurationUserinfoSignedResponseAlg: OpenID Connect User Userinfo Signing Algorithm Algorithm used to sign OpenID Connect Userinfo Responses.

-> OidcConfiguration

Construct a value of type OidcConfiguration (by applying it's required fields, if any)

OidcUserInfo

data OidcUserInfo

OidcUserInfo OpenID Connect Userinfo

Constructors

OidcUserInfo

Fields

• oidcUserInfoBirthdate :: Maybe Text

  "birthdate" - End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates.

• oidcUserInfoEmail :: Maybe Text

  "email" - End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.

• oidcUserInfoEmailVerified :: Maybe Bool

  "email_verified" - True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.

• oidcUserInfoFamilyName :: Maybe Text

  "family_name" - Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.

• oidcUserInfoGender :: Maybe Text

  "gender" - End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable.

• oidcUserInfoGivenName :: Maybe Text

  "given_name" - Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.

• oidcUserInfoLocale :: Maybe Text

  "locale" - End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well.

• oidcUserInfoMiddleName :: Maybe Text

  "middle_name" - Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.

• oidcUserInfoName :: Maybe Text

  "name" - End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.

• oidcUserInfoNickname :: Maybe Text

  "nickname" - Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.

• oidcUserInfoPhoneNumber :: Maybe Text

  "phone_number" - End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, [phone] or [phone]. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, [phone];ext=5678.

• oidcUserInfoPhoneNumberVerified :: Maybe Bool

  "phone_number_verified" - True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format.

• oidcUserInfoPicture :: Maybe Text

  "picture" - URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User.

• oidcUserInfoPreferredUsername :: Maybe Text

  "preferred_username" - Non-unique shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace.

• oidcUserInfoProfile :: Maybe Text

  "profile" - URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.

• oidcUserInfoSub :: Maybe Text

  "sub" - Subject - Identifier for the End-User at the IssuerURL.

• oidcUserInfoUpdatedAt :: Maybe Integer

  "updated_at" - Time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

• oidcUserInfoWebsite :: Maybe Text

  "website" - URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with.

• oidcUserInfoZoneinfo :: Maybe Text

  "zoneinfo" - String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, EuropeParis or AmericaLos_Angeles.

Instances

FromJSON OidcUserInfo

FromJSON OidcUserInfo

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser OidcUserInfo

parseJSONList :: Value -> Parser [OidcUserInfo]

ToJSON OidcUserInfo

ToJSON OidcUserInfo

Defined in OryHydra.Model

Methods

toJSON :: OidcUserInfo -> Value

toEncoding :: OidcUserInfo -> Encoding

toJSONList :: [OidcUserInfo] -> Value

toEncodingList :: [OidcUserInfo] -> Encoding

Show OidcUserInfo

Defined in OryHydra.Model

Methods

showsPrec :: Int -> OidcUserInfo -> ShowS

show :: OidcUserInfo -> String

showList :: [OidcUserInfo] -> ShowS

Eq OidcUserInfo

Defined in OryHydra.Model

Methods

(==) :: OidcUserInfo -> OidcUserInfo -> Bool

(/=) :: OidcUserInfo -> OidcUserInfo -> Bool

mkOidcUserInfo :: OidcUserInfo

Construct a value of type OidcUserInfo (by applying it's required fields, if any)

Pagination

data Pagination

Pagination

Constructors

Pagination

Fields

• paginationPageSize :: Maybe Integer

  "page_size" - Items per page This is the number of items per page to return. For details on pagination please head over to the pagination documentation.

• paginationPageToken :: Maybe Text

  "page_token" - Next Page Token The next page token. For details on pagination please head over to the pagination documentation.

Instances

FromJSON Pagination

FromJSON Pagination

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser Pagination

parseJSONList :: Value -> Parser [Pagination]

ToJSON Pagination

ToJSON Pagination

Defined in OryHydra.Model

Methods

toJSON :: Pagination -> Value

toEncoding :: Pagination -> Encoding

toJSONList :: [Pagination] -> Value

toEncodingList :: [Pagination] -> Encoding

Show Pagination

Defined in OryHydra.Model

Methods

showsPrec :: Int -> Pagination -> ShowS

show :: Pagination -> String

showList :: [Pagination] -> ShowS

Eq Pagination

Defined in OryHydra.Model

Methods

(==) :: Pagination -> Pagination -> Bool

(/=) :: Pagination -> Pagination -> Bool

mkPagination :: Pagination

Construct a value of type Pagination (by applying it's required fields, if any)

PaginationHeaders

data PaginationHeaders

PaginationHeaders

Constructors

PaginationHeaders

Fields

• paginationHeadersLink :: Maybe Text

  "link" - The link header contains pagination links. For details on pagination please head over to the pagination documentation. in: header

• paginationHeadersXTotalCount :: Maybe Text

  "x-total-count" - The total number of clients. in: header

Instances

FromJSON PaginationHeaders

FromJSON PaginationHeaders

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser PaginationHeaders

parseJSONList :: Value -> Parser [PaginationHeaders]

ToJSON PaginationHeaders

ToJSON PaginationHeaders

Defined in OryHydra.Model

Methods

toJSON :: PaginationHeaders -> Value

toEncoding :: PaginationHeaders -> Encoding

toJSONList :: [PaginationHeaders] -> Value

toEncodingList :: [PaginationHeaders] -> Encoding

Show PaginationHeaders

Defined in OryHydra.Model

Methods

showsPrec :: Int -> PaginationHeaders -> ShowS

show :: PaginationHeaders -> String

showList :: [PaginationHeaders] -> ShowS

Eq PaginationHeaders

Defined in OryHydra.Model

Methods

(==) :: PaginationHeaders -> PaginationHeaders -> Bool

(/=) :: PaginationHeaders -> PaginationHeaders -> Bool

mkPaginationHeaders :: PaginationHeaders

Construct a value of type PaginationHeaders (by applying it's required fields, if any)

RejectOAuth2Request

data RejectOAuth2Request

RejectOAuth2Request The request payload used to accept a login or consent request.

Constructors

RejectOAuth2Request

Fields

• rejectOAuth2RequestError :: Maybe Text

  "error" - The error should follow the OAuth2 error format (e.g. `invalid_request`, `login_required`). Defaults to `request_denied`.

• rejectOAuth2RequestErrorDebug :: Maybe Text

  "error_debug" - Debug contains information to help resolve the problem as a developer. Usually not exposed to the public but only in the server logs.

• rejectOAuth2RequestErrorDescription :: Maybe Text

  "error_description" - Description of the error in a human readable format.

• rejectOAuth2RequestErrorHint :: Maybe Text

  "error_hint" - Hint to help resolve the error.

• rejectOAuth2RequestStatusCode :: Maybe Integer

  "status_code" - Represents the HTTP status code of the error (e.g. 401 or 403) Defaults to 400

Instances

FromJSON RejectOAuth2Request

FromJSON RejectOAuth2Request

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser RejectOAuth2Request

parseJSONList :: Value -> Parser [RejectOAuth2Request]

ToJSON RejectOAuth2Request

ToJSON RejectOAuth2Request

Defined in OryHydra.Model

Methods

toJSON :: RejectOAuth2Request -> Value

toEncoding :: RejectOAuth2Request -> Encoding

toJSONList :: [RejectOAuth2Request] -> Value

toEncodingList :: [RejectOAuth2Request] -> Encoding

Show RejectOAuth2Request

Defined in OryHydra.Model

Methods

showsPrec :: Int -> RejectOAuth2Request -> ShowS

show :: RejectOAuth2Request -> String

showList :: [RejectOAuth2Request] -> ShowS

Eq RejectOAuth2Request

Defined in OryHydra.Model

Methods

(==) :: RejectOAuth2Request -> RejectOAuth2Request -> Bool

(/=) :: RejectOAuth2Request -> RejectOAuth2Request -> Bool

HasBodyParam RejectOAuth2ConsentRequest RejectOAuth2Request

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes RejectOAuth2ConsentRequest contentType, MimeRender contentType RejectOAuth2Request) => OryHydraRequest RejectOAuth2ConsentRequest contentType res accept -> RejectOAuth2Request -> OryHydraRequest RejectOAuth2ConsentRequest contentType res accept

HasBodyParam RejectOAuth2LoginRequest RejectOAuth2Request

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes RejectOAuth2LoginRequest contentType, MimeRender contentType RejectOAuth2Request) => OryHydraRequest RejectOAuth2LoginRequest contentType res accept -> RejectOAuth2Request -> OryHydraRequest RejectOAuth2LoginRequest contentType res accept

mkRejectOAuth2Request :: RejectOAuth2Request

Construct a value of type RejectOAuth2Request (by applying it's required fields, if any)

TokenPagination

data TokenPagination

TokenPagination

Constructors

TokenPagination

Fields

• tokenPaginationPageSize :: Maybe Integer

  "page_size" - Items per page This is the number of items per page to return. For details on pagination please head over to the pagination documentation.

• tokenPaginationPageToken :: Maybe Text

  "page_token" - Next Page Token The next page token. For details on pagination please head over to the pagination documentation.

Instances

FromJSON TokenPagination

FromJSON TokenPagination

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser TokenPagination

parseJSONList :: Value -> Parser [TokenPagination]

ToJSON TokenPagination

ToJSON TokenPagination

Defined in OryHydra.Model

Methods

toJSON :: TokenPagination -> Value

toEncoding :: TokenPagination -> Encoding

toJSONList :: [TokenPagination] -> Value

toEncodingList :: [TokenPagination] -> Encoding

Show TokenPagination

Defined in OryHydra.Model

Methods

showsPrec :: Int -> TokenPagination -> ShowS

show :: TokenPagination -> String

showList :: [TokenPagination] -> ShowS

Eq TokenPagination

Defined in OryHydra.Model

Methods

(==) :: TokenPagination -> TokenPagination -> Bool

(/=) :: TokenPagination -> TokenPagination -> Bool

mkTokenPagination :: TokenPagination

Construct a value of type TokenPagination (by applying it's required fields, if any)

TokenPaginationHeaders

data TokenPaginationHeaders

TokenPaginationHeaders

Constructors

TokenPaginationHeaders

Fields

• tokenPaginationHeadersLink :: Maybe Text

  "link" - The link header contains pagination links. For details on pagination please head over to the pagination documentation. in: header

• tokenPaginationHeadersXTotalCount :: Maybe Text

  "x-total-count" - The total number of clients. in: header

Instances

FromJSON TokenPaginationHeaders

FromJSON TokenPaginationHeaders

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser TokenPaginationHeaders

parseJSONList :: Value -> Parser [TokenPaginationHeaders]

ToJSON TokenPaginationHeaders

ToJSON TokenPaginationHeaders

Defined in OryHydra.Model

Methods

toJSON :: TokenPaginationHeaders -> Value

toEncoding :: TokenPaginationHeaders -> Encoding

toJSONList :: [TokenPaginationHeaders] -> Value

toEncodingList :: [TokenPaginationHeaders] -> Encoding

Show TokenPaginationHeaders

Defined in OryHydra.Model

Methods

showsPrec :: Int -> TokenPaginationHeaders -> ShowS

show :: TokenPaginationHeaders -> String

showList :: [TokenPaginationHeaders] -> ShowS

Eq TokenPaginationHeaders

Defined in OryHydra.Model

Methods

(==) :: TokenPaginationHeaders -> TokenPaginationHeaders -> Bool

(/=) :: TokenPaginationHeaders -> TokenPaginationHeaders -> Bool

mkTokenPaginationHeaders :: TokenPaginationHeaders

Construct a value of type TokenPaginationHeaders (by applying it's required fields, if any)

TokenPaginationRequestParameters

data TokenPaginationRequestParameters

TokenPaginationRequestParameters Pagination Request Parameters

The Link HTTP header contains multiple links (first, next, last, previous) formatted as: `https://{project-slug}.projects.oryapis.com/admin/clients?page_size={limit}&page_token={offset}; rel="{page}"` For details on pagination please head over to the pagination documentation.

Constructors

TokenPaginationRequestParameters

Fields

• tokenPaginationRequestParametersPageSize :: Maybe Integer

  "page_size" - Items per Page This is the number of items per page to return. For details on pagination please head over to the pagination documentation.

• tokenPaginationRequestParametersPageToken :: Maybe Text

  "page_token" - Next Page Token The next page token. For details on pagination please head over to the pagination documentation.

Instances

FromJSON TokenPaginationRequestParameters

FromJSON TokenPaginationRequestParameters

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser TokenPaginationRequestParameters

parseJSONList :: Value -> Parser [TokenPaginationRequestParameters]

ToJSON TokenPaginationRequestParameters

ToJSON TokenPaginationRequestParameters

Defined in OryHydra.Model

Methods

toJSON :: TokenPaginationRequestParameters -> Value

toEncoding :: TokenPaginationRequestParameters -> Encoding

toJSONList :: [TokenPaginationRequestParameters] -> Value

toEncodingList :: [TokenPaginationRequestParameters] -> Encoding

Show TokenPaginationRequestParameters

Defined in OryHydra.Model

Methods

showsPrec :: Int -> TokenPaginationRequestParameters -> ShowS

show :: TokenPaginationRequestParameters -> String

showList :: [TokenPaginationRequestParameters] -> ShowS

Eq TokenPaginationRequestParameters

Defined in OryHydra.Model

Methods

(==) :: TokenPaginationRequestParameters -> TokenPaginationRequestParameters -> Bool

(/=) :: TokenPaginationRequestParameters -> TokenPaginationRequestParameters -> Bool

mkTokenPaginationRequestParameters :: TokenPaginationRequestParameters

Construct a value of type TokenPaginationRequestParameters (by applying it's required fields, if any)

TokenPaginationResponseHeaders

data TokenPaginationResponseHeaders

TokenPaginationResponseHeaders Pagination Response Header

The Link HTTP header contains multiple links (first, next, last, previous) formatted as: `https://{project-slug}.projects.oryapis.com/admin/clients?page_size={limit}&page_token={offset}; rel="{page}"` For details on pagination please head over to the pagination documentation.

Constructors

TokenPaginationResponseHeaders

Fields

• tokenPaginationResponseHeadersLink :: Maybe Text

  "link" - The Link HTTP Header The `Link` header contains a comma-delimited list of links to the following pages: first: The first page of results. next: The next page of results. prev: The previous page of results. last: The last page of results. Pages are omitted if they do not exist. For example, if there is no next page, the `next` link is omitted. Examples: <clients?page_size=5&page_token=0>; rel="first",<clients?page_size=5&page_token=15>; rel="next",<clients?page_size=5&page_token=5>; rel="prev",<clients?page_size=5&page_token=20>; rel="last"

• tokenPaginationResponseHeadersXTotalCount :: Maybe Integer

  "x-total-count" - The X-Total-Count HTTP Header The `X-Total-Count` header contains the total number of items in the collection.

Instances

FromJSON TokenPaginationResponseHeaders

FromJSON TokenPaginationResponseHeaders

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser TokenPaginationResponseHeaders

parseJSONList :: Value -> Parser [TokenPaginationResponseHeaders]

ToJSON TokenPaginationResponseHeaders

ToJSON TokenPaginationResponseHeaders

Defined in OryHydra.Model

Methods

toJSON :: TokenPaginationResponseHeaders -> Value

toEncoding :: TokenPaginationResponseHeaders -> Encoding

toJSONList :: [TokenPaginationResponseHeaders] -> Value

toEncodingList :: [TokenPaginationResponseHeaders] -> Encoding

Show TokenPaginationResponseHeaders

Defined in OryHydra.Model

Methods

showsPrec :: Int -> TokenPaginationResponseHeaders -> ShowS

show :: TokenPaginationResponseHeaders -> String

showList :: [TokenPaginationResponseHeaders] -> ShowS

Eq TokenPaginationResponseHeaders

Defined in OryHydra.Model

Methods

(==) :: TokenPaginationResponseHeaders -> TokenPaginationResponseHeaders -> Bool

(/=) :: TokenPaginationResponseHeaders -> TokenPaginationResponseHeaders -> Bool

mkTokenPaginationResponseHeaders :: TokenPaginationResponseHeaders

Construct a value of type TokenPaginationResponseHeaders (by applying it's required fields, if any)

TrustOAuth2JwtGrantIssuer

data TrustOAuth2JwtGrantIssuer

TrustOAuth2JwtGrantIssuer Trust OAuth2 JWT Bearer Grant Type Issuer Request Body

Constructors

TrustOAuth2JwtGrantIssuer

Fields

• trustOAuth2JwtGrantIssuerAllowAnySubject :: Maybe Bool

  "allow_any_subject" - The "allow_any_subject" indicates that the issuer is allowed to have any principal as the subject of the JWT.

• trustOAuth2JwtGrantIssuerExpiresAt :: DateTime

  Required "expires_at" - The "expires_at" indicates, when grant will expire, so we will reject assertion from "issuer" targeting "subject".

• trustOAuth2JwtGrantIssuerIssuer :: Text

  Required "issuer" - The "issuer" identifies the principal that issued the JWT assertion (same as "iss" claim in JWT).

• trustOAuth2JwtGrantIssuerJwk :: JsonWebKey

  Required "jwk"

• trustOAuth2JwtGrantIssuerScope :: [Text]

  Required "scope" - The "scope" contains list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749])

• trustOAuth2JwtGrantIssuerSubject :: Maybe Text

  "subject" - The "subject" identifies the principal that is the subject of the JWT.

Instances

FromJSON TrustOAuth2JwtGrantIssuer

FromJSON TrustOAuth2JwtGrantIssuer

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser TrustOAuth2JwtGrantIssuer

parseJSONList :: Value -> Parser [TrustOAuth2JwtGrantIssuer]

ToJSON TrustOAuth2JwtGrantIssuer

ToJSON TrustOAuth2JwtGrantIssuer

Defined in OryHydra.Model

Methods

toJSON :: TrustOAuth2JwtGrantIssuer -> Value

toEncoding :: TrustOAuth2JwtGrantIssuer -> Encoding

toJSONList :: [TrustOAuth2JwtGrantIssuer] -> Value

toEncodingList :: [TrustOAuth2JwtGrantIssuer] -> Encoding

Show TrustOAuth2JwtGrantIssuer

Defined in OryHydra.Model

Methods

showsPrec :: Int -> TrustOAuth2JwtGrantIssuer -> ShowS

show :: TrustOAuth2JwtGrantIssuer -> String

showList :: [TrustOAuth2JwtGrantIssuer] -> ShowS

Eq TrustOAuth2JwtGrantIssuer

Defined in OryHydra.Model

Methods

(==) :: TrustOAuth2JwtGrantIssuer -> TrustOAuth2JwtGrantIssuer -> Bool

(/=) :: TrustOAuth2JwtGrantIssuer -> TrustOAuth2JwtGrantIssuer -> Bool

HasBodyParam TrustOAuth2JwtGrantIssuer0 TrustOAuth2JwtGrantIssuer

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes TrustOAuth2JwtGrantIssuer0 contentType, MimeRender contentType TrustOAuth2JwtGrantIssuer) => OryHydraRequest TrustOAuth2JwtGrantIssuer0 contentType res accept -> TrustOAuth2JwtGrantIssuer -> OryHydraRequest TrustOAuth2JwtGrantIssuer0 contentType res accept

mkTrustOAuth2JwtGrantIssuer

Arguments

:: DateTime

trustOAuth2JwtGrantIssuerExpiresAt: The "expires_at" indicates, when grant will expire, so we will reject assertion from "issuer" targeting "subject".

-> Text

trustOAuth2JwtGrantIssuerIssuer: The "issuer" identifies the principal that issued the JWT assertion (same as "iss" claim in JWT).

-> JsonWebKey

trustOAuth2JwtGrantIssuerJwk

-> [Text]

trustOAuth2JwtGrantIssuerScope: The "scope" contains list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749])

-> TrustOAuth2JwtGrantIssuer

Construct a value of type TrustOAuth2JwtGrantIssuer (by applying it's required fields, if any)

TrustedOAuth2JwtGrantIssuer

data TrustedOAuth2JwtGrantIssuer

TrustedOAuth2JwtGrantIssuer OAuth2 JWT Bearer Grant Type Issuer Trust Relationship

Constructors

TrustedOAuth2JwtGrantIssuer

Fields

• trustedOAuth2JwtGrantIssuerAllowAnySubject :: Maybe Bool

  "allow_any_subject" - The "allow_any_subject" indicates that the issuer is allowed to have any principal as the subject of the JWT.

• trustedOAuth2JwtGrantIssuerCreatedAt :: Maybe DateTime

  "created_at" - The "created_at" indicates, when grant was created.

• trustedOAuth2JwtGrantIssuerExpiresAt :: Maybe DateTime

  "expires_at" - The "expires_at" indicates, when grant will expire, so we will reject assertion from "issuer" targeting "subject".

• trustedOAuth2JwtGrantIssuerId :: Maybe Text

  "id"

• trustedOAuth2JwtGrantIssuerIssuer :: Maybe Text

  "issuer" - The "issuer" identifies the principal that issued the JWT assertion (same as "iss" claim in JWT).

• trustedOAuth2JwtGrantIssuerPublicKey :: Maybe TrustedOAuth2JwtGrantJsonWebKey

  "public_key"

• trustedOAuth2JwtGrantIssuerScope :: Maybe [Text]

  "scope" - The "scope" contains list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749])

• trustedOAuth2JwtGrantIssuerSubject :: Maybe Text

  "subject" - The "subject" identifies the principal that is the subject of the JWT.

Instances

FromJSON TrustedOAuth2JwtGrantIssuer

FromJSON TrustedOAuth2JwtGrantIssuer

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser TrustedOAuth2JwtGrantIssuer

parseJSONList :: Value -> Parser [TrustedOAuth2JwtGrantIssuer]

ToJSON TrustedOAuth2JwtGrantIssuer

ToJSON TrustedOAuth2JwtGrantIssuer

Defined in OryHydra.Model

Methods

toJSON :: TrustedOAuth2JwtGrantIssuer -> Value

toEncoding :: TrustedOAuth2JwtGrantIssuer -> Encoding

toJSONList :: [TrustedOAuth2JwtGrantIssuer] -> Value

toEncodingList :: [TrustedOAuth2JwtGrantIssuer] -> Encoding

Show TrustedOAuth2JwtGrantIssuer

Defined in OryHydra.Model

Methods

showsPrec :: Int -> TrustedOAuth2JwtGrantIssuer -> ShowS

show :: TrustedOAuth2JwtGrantIssuer -> String

showList :: [TrustedOAuth2JwtGrantIssuer] -> ShowS

Eq TrustedOAuth2JwtGrantIssuer

Defined in OryHydra.Model

Methods

(==) :: TrustedOAuth2JwtGrantIssuer -> TrustedOAuth2JwtGrantIssuer -> Bool

(/=) :: TrustedOAuth2JwtGrantIssuer -> TrustedOAuth2JwtGrantIssuer -> Bool

mkTrustedOAuth2JwtGrantIssuer :: TrustedOAuth2JwtGrantIssuer

Construct a value of type TrustedOAuth2JwtGrantIssuer (by applying it's required fields, if any)

TrustedOAuth2JwtGrantJsonWebKey

data TrustedOAuth2JwtGrantJsonWebKey

TrustedOAuth2JwtGrantJsonWebKey OAuth2 JWT Bearer Grant Type Issuer Trusted JSON Web Key

Constructors

TrustedOAuth2JwtGrantJsonWebKey

Fields

• trustedOAuth2JwtGrantJsonWebKeyKid :: Maybe Text

  "kid" - The "key_id" is key unique identifier (same as kid header in jws/jwt).

• trustedOAuth2JwtGrantJsonWebKeySet :: Maybe Text

  "set" - The "set" is basically a name for a group(set) of keys. Will be the same as "issuer" in grant.

Instances

FromJSON TrustedOAuth2JwtGrantJsonWebKey

FromJSON TrustedOAuth2JwtGrantJsonWebKey

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser TrustedOAuth2JwtGrantJsonWebKey

parseJSONList :: Value -> Parser [TrustedOAuth2JwtGrantJsonWebKey]

ToJSON TrustedOAuth2JwtGrantJsonWebKey

ToJSON TrustedOAuth2JwtGrantJsonWebKey

Defined in OryHydra.Model

Methods

toJSON :: TrustedOAuth2JwtGrantJsonWebKey -> Value

toEncoding :: TrustedOAuth2JwtGrantJsonWebKey -> Encoding

toJSONList :: [TrustedOAuth2JwtGrantJsonWebKey] -> Value

toEncodingList :: [TrustedOAuth2JwtGrantJsonWebKey] -> Encoding

Show TrustedOAuth2JwtGrantJsonWebKey

Defined in OryHydra.Model

Methods

showsPrec :: Int -> TrustedOAuth2JwtGrantJsonWebKey -> ShowS

show :: TrustedOAuth2JwtGrantJsonWebKey -> String

showList :: [TrustedOAuth2JwtGrantJsonWebKey] -> ShowS

Eq TrustedOAuth2JwtGrantJsonWebKey

Defined in OryHydra.Model

Methods

(==) :: TrustedOAuth2JwtGrantJsonWebKey -> TrustedOAuth2JwtGrantJsonWebKey -> Bool

(/=) :: TrustedOAuth2JwtGrantJsonWebKey -> TrustedOAuth2JwtGrantJsonWebKey -> Bool

mkTrustedOAuth2JwtGrantJsonWebKey :: TrustedOAuth2JwtGrantJsonWebKey

Construct a value of type TrustedOAuth2JwtGrantJsonWebKey (by applying it's required fields, if any)

Version

data Version

Version

Constructors

Version

Fields

• versionVersion :: Maybe Text

  "version" - Version is the service's version.

Instances

FromJSON Version

FromJSON Version

Defined in OryHydra.Model

Methods

parseJSON :: Value -> Parser Version

parseJSONList :: Value -> Parser [Version]

ToJSON Version

ToJSON Version

Defined in OryHydra.Model

Methods

toJSON :: Version -> Value

toEncoding :: Version -> Encoding

toJSONList :: [Version] -> Value

toEncodingList :: [Version] -> Encoding

Show Version

Defined in OryHydra.Model

Methods

showsPrec :: Int -> Version -> ShowS

show :: Version -> String

showList :: [Version] -> ShowS

Eq Version

Defined in OryHydra.Model

Methods

(==) :: Version -> Version -> Bool

(/=) :: Version -> Version -> Bool

mkVersion :: Version

Construct a value of type Version (by applying it's required fields, if any)

Auth Methods

AuthBasicBasic

data AuthBasicBasic

Constructors

AuthBasicBasic ByteString ByteString

username password

Instances

Show AuthBasicBasic

Defined in OryHydra.Model

Methods

showsPrec :: Int -> AuthBasicBasic -> ShowS

show :: AuthBasicBasic -> String

showList :: [AuthBasicBasic] -> ShowS

Eq AuthBasicBasic

Defined in OryHydra.Model

Methods

(==) :: AuthBasicBasic -> AuthBasicBasic -> Bool

(/=) :: AuthBasicBasic -> AuthBasicBasic -> Bool

AuthMethod AuthBasicBasic

Defined in OryHydra.Model

Methods

applyAuthMethod :: OryHydraConfig -> AuthBasicBasic -> OryHydraRequest req contentType res accept -> IO (OryHydraRequest req contentType res accept)

AuthBasicBearer

data AuthBasicBearer

Constructors

AuthBasicBearer ByteString ByteString

username password

Instances

Show AuthBasicBearer

Defined in OryHydra.Model

Methods

showsPrec :: Int -> AuthBasicBearer -> ShowS

show :: AuthBasicBearer -> String

showList :: [AuthBasicBearer] -> ShowS

Eq AuthBasicBearer

Defined in OryHydra.Model

Methods

(==) :: AuthBasicBearer -> AuthBasicBearer -> Bool

(/=) :: AuthBasicBearer -> AuthBasicBearer -> Bool

AuthMethod AuthBasicBearer

Defined in OryHydra.Model

Methods

applyAuthMethod :: OryHydraConfig -> AuthBasicBearer -> OryHydraRequest req contentType res accept -> IO (OryHydraRequest req contentType res accept)

AuthOAuthOauth2

data AuthOAuthOauth2

Constructors

AuthOAuthOauth2 Text

secret

Instances

Show AuthOAuthOauth2

Defined in OryHydra.Model

Methods

showsPrec :: Int -> AuthOAuthOauth2 -> ShowS

show :: AuthOAuthOauth2 -> String

showList :: [AuthOAuthOauth2] -> ShowS

Eq AuthOAuthOauth2

Defined in OryHydra.Model

Methods

(==) :: AuthOAuthOauth2 -> AuthOAuthOauth2 -> Bool

(/=) :: AuthOAuthOauth2 -> AuthOAuthOauth2 -> Bool

AuthMethod AuthOAuthOauth2

Defined in OryHydra.Model

Methods

applyAuthMethod :: OryHydraConfig -> AuthOAuthOauth2 -> OryHydraRequest req contentType res accept -> IO (OryHydraRequest req contentType res accept)