ORYHydra.Model

Parameter newtypes

All

newtype All

Constructors

All

Fields

• unAll :: Bool

Instances

Eq All

Defined in ORYHydra.Model

Methods

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

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

Show All

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> All -> ShowS

show :: All -> String

showList :: [All] -> ShowS

HasOptionalParam RevokeConsentSessions All

Optional Param "all" - If set to `?all=true`, deletes all consent sessions by the Subject that have been granted.

Defined in ORYHydra.API.Admin

Methods

applyOptionalParam :: ORYHydraRequest RevokeConsentSessions contentType res accept -> All -> ORYHydraRequest RevokeConsentSessions contentType res accept

(-&-) :: ORYHydraRequest RevokeConsentSessions contentType res accept -> All -> ORYHydraRequest RevokeConsentSessions contentType res accept

Client

newtype Client

Constructors

Client

Fields

• unClient :: Text

Instances

Eq Client

Defined in ORYHydra.Model

Methods

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

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

Show Client

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> Client -> ShowS

show :: Client -> String

showList :: [Client] -> ShowS

HasOptionalParam RevokeConsentSessions Client

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

Defined in ORYHydra.API.Admin

Methods

applyOptionalParam :: ORYHydraRequest RevokeConsentSessions contentType res accept -> Client -> ORYHydraRequest RevokeConsentSessions contentType res accept

(-&-) :: ORYHydraRequest RevokeConsentSessions contentType res accept -> Client -> ORYHydraRequest RevokeConsentSessions contentType res accept

ClientId

newtype ClientId

Constructors

ClientId

Fields

• unClientId :: Text

Instances

Eq ClientId

Defined in ORYHydra.Model

Methods

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

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

Show ClientId

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> ClientId -> ShowS

show :: ClientId -> String

showList :: [ClientId] -> ShowS

HasOptionalParam Oauth2Token ClientId

Defined in ORYHydra.API.Public

Methods

applyOptionalParam :: ORYHydraRequest Oauth2Token contentType res accept -> ClientId -> ORYHydraRequest Oauth2Token contentType res accept

(-&-) :: ORYHydraRequest Oauth2Token contentType res accept -> ClientId -> ORYHydraRequest Oauth2Token contentType res accept

Code

newtype Code

Constructors

Code

Fields

• unCode :: Text

Instances

Eq Code

Defined in ORYHydra.Model

Methods

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

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

Show Code

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> Code -> ShowS

show :: Code -> String

showList :: [Code] -> ShowS

HasOptionalParam Oauth2Token Code

Defined in ORYHydra.API.Public

Methods

applyOptionalParam :: ORYHydraRequest Oauth2Token contentType res accept -> Code -> ORYHydraRequest Oauth2Token contentType res accept

(-&-) :: ORYHydraRequest Oauth2Token contentType res accept -> Code -> ORYHydraRequest Oauth2Token contentType res accept

ConsentChallenge

newtype ConsentChallenge

Constructors

ConsentChallenge

Fields

• unConsentChallenge :: Text

Instances

Eq ConsentChallenge

Defined in ORYHydra.Model

Methods

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

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

Show ConsentChallenge

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> ConsentChallenge -> ShowS

show :: ConsentChallenge -> String

showList :: [ConsentChallenge] -> ShowS

GrantType

newtype GrantType

Constructors

GrantType

Fields

• unGrantType :: Text

Instances

Eq GrantType

Defined in ORYHydra.Model

Methods

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

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

Show GrantType

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> GrantType -> ShowS

show :: GrantType -> String

showList :: [GrantType] -> ShowS

Id

newtype Id

Constructors

Id

Fields

• unId :: Text

Instances

Eq Id

Defined in ORYHydra.Model

Methods

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

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

Show Id

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> Id -> ShowS

show :: Id -> String

showList :: [Id] -> ShowS

Kid

newtype Kid

Constructors

Kid

Fields

• unKid :: Text

Instances

Eq Kid

Defined in ORYHydra.Model

Methods

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

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

Show Kid

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> Kid -> ShowS

show :: Kid -> String

showList :: [Kid] -> ShowS

Limit

newtype Limit

Constructors

Limit

Fields

• unLimit :: Integer

Instances

Eq Limit

Defined in ORYHydra.Model

Methods

(==) :: Limit -> Limit -> Bool

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

Show Limit

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> Limit -> ShowS

show :: Limit -> String

showList :: [Limit] -> ShowS

HasOptionalParam ListOAuth2Clients Limit

Optional Param "limit" - The maximum amount of policies returned, upper bound is 500 policies

Defined in ORYHydra.API.Admin

Methods

applyOptionalParam :: ORYHydraRequest ListOAuth2Clients contentType res accept -> Limit -> ORYHydraRequest ListOAuth2Clients contentType res accept

(-&-) :: ORYHydraRequest ListOAuth2Clients contentType res accept -> Limit -> ORYHydraRequest ListOAuth2Clients contentType res accept

LoginChallenge

newtype LoginChallenge

Constructors

LoginChallenge

Fields

• unLoginChallenge :: Text

Instances

Eq LoginChallenge

Defined in ORYHydra.Model

Methods

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

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

Show LoginChallenge

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> LoginChallenge -> ShowS

show :: LoginChallenge -> String

showList :: [LoginChallenge] -> ShowS

LogoutChallenge

newtype LogoutChallenge

Constructors

LogoutChallenge

Fields

• unLogoutChallenge :: Text

Instances

Eq LogoutChallenge

Defined in ORYHydra.Model

Methods

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

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

Show LogoutChallenge

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> LogoutChallenge -> ShowS

show :: LogoutChallenge -> String

showList :: [LogoutChallenge] -> ShowS

Offset

newtype Offset

Constructors

Offset

Fields

• unOffset :: Integer

Instances

Eq Offset

Defined in ORYHydra.Model

Methods

(==) :: Offset -> Offset -> Bool

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

Show Offset

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> Offset -> ShowS

show :: Offset -> String

showList :: [Offset] -> ShowS

HasOptionalParam ListOAuth2Clients Offset

Optional Param "offset" - The offset from where to start looking.

Defined in ORYHydra.API.Admin

Methods

applyOptionalParam :: ORYHydraRequest ListOAuth2Clients contentType res accept -> Offset -> ORYHydraRequest ListOAuth2Clients contentType res accept

(-&-) :: ORYHydraRequest ListOAuth2Clients contentType res accept -> Offset -> ORYHydraRequest ListOAuth2Clients contentType res accept

RedirectUri

newtype RedirectUri

Constructors

RedirectUri

Fields

• unRedirectUri :: Text

Instances

Eq RedirectUri

Defined in ORYHydra.Model

Methods

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

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

Show RedirectUri

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> RedirectUri -> ShowS

show :: RedirectUri -> String

showList :: [RedirectUri] -> ShowS

HasOptionalParam Oauth2Token RedirectUri

Defined in ORYHydra.API.Public

Methods

applyOptionalParam :: ORYHydraRequest Oauth2Token contentType res accept -> RedirectUri -> ORYHydraRequest Oauth2Token contentType res accept

(-&-) :: ORYHydraRequest Oauth2Token contentType res accept -> RedirectUri -> ORYHydraRequest Oauth2Token contentType res accept

RefreshToken

newtype RefreshToken

Constructors

RefreshToken

Fields

• unRefreshToken :: Text

Instances

Eq RefreshToken

Defined in ORYHydra.Model

Methods

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

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

Show RefreshToken

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> RefreshToken -> ShowS

show :: RefreshToken -> String

showList :: [RefreshToken] -> ShowS

HasOptionalParam Oauth2Token RefreshToken

Defined in ORYHydra.API.Public

Methods

applyOptionalParam :: ORYHydraRequest Oauth2Token contentType res accept -> RefreshToken -> ORYHydraRequest Oauth2Token contentType res accept

(-&-) :: ORYHydraRequest Oauth2Token contentType res accept -> RefreshToken -> ORYHydraRequest Oauth2Token contentType res accept

Scope

newtype Scope

Constructors

Scope

Fields

• unScope :: Text

Instances

Eq Scope

Defined in ORYHydra.Model

Methods

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

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

Show Scope

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> Scope -> ShowS

show :: Scope -> String

showList :: [Scope] -> ShowS

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.Admin

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

Eq Set

Defined in ORYHydra.Model

Methods

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

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

Show Set

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> Set -> ShowS

show :: Set -> String

showList :: [Set] -> ShowS

Subject

newtype Subject

Constructors

Subject

Fields

• unSubject :: Text

Instances

Eq Subject

Defined in ORYHydra.Model

Methods

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

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

Show Subject

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> Subject -> ShowS

show :: Subject -> String

showList :: [Subject] -> ShowS

Token

newtype Token

Constructors

Token

Fields

• unToken :: Text

Instances

Eq Token

Defined in ORYHydra.Model

Methods

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

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

Show Token

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> Token -> ShowS

show :: Token -> String

showList :: [Token] -> ShowS

Models

AcceptConsentRequest

data AcceptConsentRequest

AcceptConsentRequest The request payload used to accept a consent request.

Constructors

AcceptConsentRequest

Fields

• acceptConsentRequestGrantAccessTokenAudience :: Maybe [Text]

  "grant_access_token_audience"

• acceptConsentRequestGrantScope :: Maybe [Text]

  "grant_scope"

• acceptConsentRequestHandledAt :: Maybe DateTime

  "handled_at"

• acceptConsentRequestRemember :: 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.

• acceptConsentRequestRememberFor :: 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.

• acceptConsentRequestSession :: Maybe ConsentRequestSession

  "session"

Instances

Eq AcceptConsentRequest

Defined in ORYHydra.Model

Methods

(==) :: AcceptConsentRequest -> AcceptConsentRequest -> Bool

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

Show AcceptConsentRequest

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> AcceptConsentRequest -> ShowS

show :: AcceptConsentRequest -> String

showList :: [AcceptConsentRequest] -> ShowS

ToJSON AcceptConsentRequest

ToJSON AcceptConsentRequest

Defined in ORYHydra.Model

Methods

toJSON :: AcceptConsentRequest -> Value

toEncoding :: AcceptConsentRequest -> Encoding

toJSONList :: [AcceptConsentRequest] -> Value

toEncodingList :: [AcceptConsentRequest] -> Encoding

FromJSON AcceptConsentRequest

FromJSON AcceptConsentRequest

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser AcceptConsentRequest

parseJSONList :: Value -> Parser [AcceptConsentRequest]

HasBodyParam AcceptConsentRequest0 AcceptConsentRequest

Defined in ORYHydra.API.Admin

Methods

setBodyParam :: (Consumes AcceptConsentRequest0 contentType, MimeRender contentType AcceptConsentRequest) => ORYHydraRequest AcceptConsentRequest0 contentType res accept -> AcceptConsentRequest -> ORYHydraRequest AcceptConsentRequest0 contentType res accept

mkAcceptConsentRequest :: AcceptConsentRequest

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

AcceptLoginRequest

data AcceptLoginRequest

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

Constructors

AcceptLoginRequest

Fields

• acceptLoginRequestAcr :: 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.

• acceptLoginRequestContext :: Maybe Value

  "context"

• acceptLoginRequestForceSubjectIdentifier :: 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.

• acceptLoginRequestRemember :: 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.

• acceptLoginRequestRememberFor :: 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).

• acceptLoginRequestSubject :: Text

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

Instances

Eq AcceptLoginRequest

Defined in ORYHydra.Model

Methods

(==) :: AcceptLoginRequest -> AcceptLoginRequest -> Bool

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

Show AcceptLoginRequest

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> AcceptLoginRequest -> ShowS

show :: AcceptLoginRequest -> String

showList :: [AcceptLoginRequest] -> ShowS

ToJSON AcceptLoginRequest

ToJSON AcceptLoginRequest

Defined in ORYHydra.Model

Methods

toJSON :: AcceptLoginRequest -> Value

toEncoding :: AcceptLoginRequest -> Encoding

toJSONList :: [AcceptLoginRequest] -> Value

toEncodingList :: [AcceptLoginRequest] -> Encoding

FromJSON AcceptLoginRequest

FromJSON AcceptLoginRequest

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser AcceptLoginRequest

parseJSONList :: Value -> Parser [AcceptLoginRequest]

HasBodyParam AcceptLoginRequest0 AcceptLoginRequest

Defined in ORYHydra.API.Admin

Methods

setBodyParam :: (Consumes AcceptLoginRequest0 contentType, MimeRender contentType AcceptLoginRequest) => ORYHydraRequest AcceptLoginRequest0 contentType res accept -> AcceptLoginRequest -> ORYHydraRequest AcceptLoginRequest0 contentType res accept

mkAcceptLoginRequest

Arguments

:: Text

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

-> AcceptLoginRequest

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

CompletedRequest

data CompletedRequest

CompletedRequest The response payload sent when accepting or rejecting a login or consent request.

Constructors

CompletedRequest

Fields

• completedRequestRedirectTo :: Text

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

Instances

Eq CompletedRequest

Defined in ORYHydra.Model

Methods

(==) :: CompletedRequest -> CompletedRequest -> Bool

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

Show CompletedRequest

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> CompletedRequest -> ShowS

show :: CompletedRequest -> String

showList :: [CompletedRequest] -> ShowS

ToJSON CompletedRequest

ToJSON CompletedRequest

Defined in ORYHydra.Model

Methods

toJSON :: CompletedRequest -> Value

toEncoding :: CompletedRequest -> Encoding

toJSONList :: [CompletedRequest] -> Value

toEncodingList :: [CompletedRequest] -> Encoding

FromJSON CompletedRequest

FromJSON CompletedRequest

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser CompletedRequest

parseJSONList :: Value -> Parser [CompletedRequest]

mkCompletedRequest

Arguments

:: Text

completedRequestRedirectTo: RedirectURL is the URL which you should redirect the user to once the authentication process is completed.

-> CompletedRequest

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

ConsentRequest

data ConsentRequest

ConsentRequest Contains information on an ongoing consent request.

Constructors

ConsentRequest

Fields

• consentRequestAcr :: 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.

• consentRequestChallenge :: Text

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

• consentRequestClient :: Maybe OAuth2Client

  "client"

• consentRequestContext :: Maybe Value

  "context"

• consentRequestLoginChallenge :: 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.

• consentRequestLoginSessionId :: 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.

• consentRequestOidcContext :: Maybe OpenIDConnectContext

  "oidc_context"

• consentRequestRequestUrl :: 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.

• consentRequestRequestedAccessTokenAudience :: Maybe [Text]

  "requested_access_token_audience"

• consentRequestRequestedScope :: Maybe [Text]

  "requested_scope"

• consentRequestSkip :: 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.

• consentRequestSubject :: 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

Eq ConsentRequest

Defined in ORYHydra.Model

Methods

(==) :: ConsentRequest -> ConsentRequest -> Bool

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

Show ConsentRequest

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> ConsentRequest -> ShowS

show :: ConsentRequest -> String

showList :: [ConsentRequest] -> ShowS

ToJSON ConsentRequest

ToJSON ConsentRequest

Defined in ORYHydra.Model

Methods

toJSON :: ConsentRequest -> Value

toEncoding :: ConsentRequest -> Encoding

toJSONList :: [ConsentRequest] -> Value

toEncodingList :: [ConsentRequest] -> Encoding

FromJSON ConsentRequest

FromJSON ConsentRequest

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser ConsentRequest

parseJSONList :: Value -> Parser [ConsentRequest]

mkConsentRequest

Arguments

:: Text

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

-> ConsentRequest

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

ConsentRequestSession

data ConsentRequestSession

ConsentRequestSession Used to pass session data to a consent request.

Constructors

ConsentRequestSession

Fields

• consentRequestSessionAccessToken :: 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!

• consentRequestSessionIdToken :: 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

Eq ConsentRequestSession

Defined in ORYHydra.Model

Methods

(==) :: ConsentRequestSession -> ConsentRequestSession -> Bool

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

Show ConsentRequestSession

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> ConsentRequestSession -> ShowS

show :: ConsentRequestSession -> String

showList :: [ConsentRequestSession] -> ShowS

ToJSON ConsentRequestSession

ToJSON ConsentRequestSession

Defined in ORYHydra.Model

Methods

toJSON :: ConsentRequestSession -> Value

toEncoding :: ConsentRequestSession -> Encoding

toJSONList :: [ConsentRequestSession] -> Value

toEncodingList :: [ConsentRequestSession] -> Encoding

FromJSON ConsentRequestSession

FromJSON ConsentRequestSession

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser ConsentRequestSession

parseJSONList :: Value -> Parser [ConsentRequestSession]

mkConsentRequestSession :: ConsentRequestSession

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

ContainerWaitOKBodyError

data ContainerWaitOKBodyError

ContainerWaitOKBodyError ContainerWaitOKBodyError container waiting error, if any

Constructors

ContainerWaitOKBodyError

Fields

• containerWaitOKBodyErrorMessage :: Maybe Text

  Message - Details of an error

Instances

Eq ContainerWaitOKBodyError

Defined in ORYHydra.Model

Methods

(==) :: ContainerWaitOKBodyError -> ContainerWaitOKBodyError -> Bool

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

Show ContainerWaitOKBodyError

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> ContainerWaitOKBodyError -> ShowS

show :: ContainerWaitOKBodyError -> String

showList :: [ContainerWaitOKBodyError] -> ShowS

ToJSON ContainerWaitOKBodyError

ToJSON ContainerWaitOKBodyError

Defined in ORYHydra.Model

Methods

toJSON :: ContainerWaitOKBodyError -> Value

toEncoding :: ContainerWaitOKBodyError -> Encoding

toJSONList :: [ContainerWaitOKBodyError] -> Value

toEncodingList :: [ContainerWaitOKBodyError] -> Encoding

FromJSON ContainerWaitOKBodyError

FromJSON ContainerWaitOKBodyError

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser ContainerWaitOKBodyError

parseJSONList :: Value -> Parser [ContainerWaitOKBodyError]

mkContainerWaitOKBodyError :: ContainerWaitOKBodyError

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

FlushInactiveOAuth2TokensRequest

data FlushInactiveOAuth2TokensRequest

FlushInactiveOAuth2TokensRequest

Constructors

FlushInactiveOAuth2TokensRequest

Fields

• flushInactiveOAuth2TokensRequestNotAfter :: Maybe DateTime

  "notAfter" - NotAfter sets after which point tokens should not be flushed. This is useful when you want to keep a history of recently issued tokens for auditing.

Instances

Eq FlushInactiveOAuth2TokensRequest

Defined in ORYHydra.Model

Methods

(==) :: FlushInactiveOAuth2TokensRequest -> FlushInactiveOAuth2TokensRequest -> Bool

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

Show FlushInactiveOAuth2TokensRequest

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> FlushInactiveOAuth2TokensRequest -> ShowS

show :: FlushInactiveOAuth2TokensRequest -> String

showList :: [FlushInactiveOAuth2TokensRequest] -> ShowS

ToJSON FlushInactiveOAuth2TokensRequest

ToJSON FlushInactiveOAuth2TokensRequest

Defined in ORYHydra.Model

Methods

toJSON :: FlushInactiveOAuth2TokensRequest -> Value

toEncoding :: FlushInactiveOAuth2TokensRequest -> Encoding

toJSONList :: [FlushInactiveOAuth2TokensRequest] -> Value

toEncodingList :: [FlushInactiveOAuth2TokensRequest] -> Encoding

FromJSON FlushInactiveOAuth2TokensRequest

FromJSON FlushInactiveOAuth2TokensRequest

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser FlushInactiveOAuth2TokensRequest

parseJSONList :: Value -> Parser [FlushInactiveOAuth2TokensRequest]

HasBodyParam FlushInactiveOAuth2Tokens FlushInactiveOAuth2TokensRequest

Defined in ORYHydra.API.Admin

Methods

setBodyParam :: (Consumes FlushInactiveOAuth2Tokens contentType, MimeRender contentType FlushInactiveOAuth2TokensRequest) => ORYHydraRequest FlushInactiveOAuth2Tokens contentType res accept -> FlushInactiveOAuth2TokensRequest -> ORYHydraRequest FlushInactiveOAuth2Tokens contentType res accept

mkFlushInactiveOAuth2TokensRequest :: FlushInactiveOAuth2TokensRequest

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

GenericError

data GenericError

GenericError Error response

Error responses are sent when an error (e.g. unauthorized, bad request, ...) occurred.

Constructors

GenericError

Fields

• genericErrorDebug :: Maybe Text

  "debug" - Debug contains debug information. This is usually not available and has to be enabled.

• genericErrorError :: Text

  Required "error" - Name is the error name.

• genericErrorErrorDescription :: Maybe Text

  "error_description" - Description contains further information on the nature of the error.

• genericErrorStatusCode :: Maybe Integer

  "status_code" - Code represents the error status code (404, 403, 401, ...).

Instances

Eq GenericError

Defined in ORYHydra.Model

Methods

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

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

Show GenericError

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> GenericError -> ShowS

show :: GenericError -> String

showList :: [GenericError] -> ShowS

ToJSON GenericError

ToJSON GenericError

Defined in ORYHydra.Model

Methods

toJSON :: GenericError -> Value

toEncoding :: GenericError -> Encoding

toJSONList :: [GenericError] -> Value

toEncodingList :: [GenericError] -> Encoding

FromJSON GenericError

FromJSON GenericError

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser GenericError

parseJSONList :: Value -> Parser [GenericError]

mkGenericError

Arguments

:: Text

genericErrorError: Name is the error name.

-> GenericError

Construct a value of type GenericError (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

Eq HealthNotReadyStatus

Defined in ORYHydra.Model

Methods

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

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

Show HealthNotReadyStatus

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> HealthNotReadyStatus -> ShowS

show :: HealthNotReadyStatus -> String

showList :: [HealthNotReadyStatus] -> ShowS

ToJSON HealthNotReadyStatus

ToJSON HealthNotReadyStatus

Defined in ORYHydra.Model

Methods

toJSON :: HealthNotReadyStatus -> Value

toEncoding :: HealthNotReadyStatus -> Encoding

toJSONList :: [HealthNotReadyStatus] -> Value

toEncodingList :: [HealthNotReadyStatus] -> Encoding

FromJSON HealthNotReadyStatus

FromJSON HealthNotReadyStatus

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser HealthNotReadyStatus

parseJSONList :: Value -> Parser [HealthNotReadyStatus]

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

Eq HealthStatus

Defined in ORYHydra.Model

Methods

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

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

Show HealthStatus

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> HealthStatus -> ShowS

show :: HealthStatus -> String

showList :: [HealthStatus] -> ShowS

ToJSON HealthStatus

ToJSON HealthStatus

Defined in ORYHydra.Model

Methods

toJSON :: HealthStatus -> Value

toEncoding :: HealthStatus -> Encoding

toJSONList :: [HealthStatus] -> Value

toEncodingList :: [HealthStatus] -> Encoding

FromJSON HealthStatus

FromJSON HealthStatus

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser HealthStatus

parseJSONList :: Value -> Parser [HealthStatus]

mkHealthStatus :: HealthStatus

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

JSONWebKey

data JSONWebKey

JSONWebKey It is important that this model object is named JSONWebKey for "swagger generate spec" to generate only on definition of a 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

Eq JSONWebKey

Defined in ORYHydra.Model

Methods

(==) :: JSONWebKey -> JSONWebKey -> Bool

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

Show JSONWebKey

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> JSONWebKey -> ShowS

show :: JSONWebKey -> String

showList :: [JSONWebKey] -> ShowS

ToJSON JSONWebKey

ToJSON JSONWebKey

Defined in ORYHydra.Model

Methods

toJSON :: JSONWebKey -> Value

toEncoding :: JSONWebKey -> Encoding

toJSONList :: [JSONWebKey] -> Value

toEncodingList :: [JSONWebKey] -> Encoding

FromJSON JSONWebKey

FromJSON JSONWebKey

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser JSONWebKey

parseJSONList :: Value -> Parser [JSONWebKey]

HasBodyParam UpdateJsonWebKey JSONWebKey

Defined in ORYHydra.API.Admin

Methods

setBodyParam :: (Consumes UpdateJsonWebKey contentType, MimeRender contentType JSONWebKey) => ORYHydraRequest UpdateJsonWebKey contentType res accept -> JSONWebKey -> ORYHydraRequest UpdateJsonWebKey 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 It is important that this model object is named JSONWebKeySet for "swagger generate spec" to generate only on definition of a JSONWebKeySet. Since one with the same name is previously defined as client.Client.JSONWebKeys and this one is last, this one will be effectively written in the swagger spec.

Constructors

JSONWebKeySet

Fields

• jSONWebKeySetKeys :: Maybe [JSONWebKey]

  "keys" - The value of the "keys" parameter is an array of 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

Eq JSONWebKeySet

Defined in ORYHydra.Model

Methods

(==) :: JSONWebKeySet -> JSONWebKeySet -> Bool

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

Show JSONWebKeySet

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> JSONWebKeySet -> ShowS

show :: JSONWebKeySet -> String

showList :: [JSONWebKeySet] -> ShowS

ToJSON JSONWebKeySet

ToJSON JSONWebKeySet

Defined in ORYHydra.Model

Methods

toJSON :: JSONWebKeySet -> Value

toEncoding :: JSONWebKeySet -> Encoding

toJSONList :: [JSONWebKeySet] -> Value

toEncodingList :: [JSONWebKeySet] -> Encoding

FromJSON JSONWebKeySet

FromJSON JSONWebKeySet

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser JSONWebKeySet

parseJSONList :: Value -> Parser [JSONWebKeySet]

HasBodyParam UpdateJsonWebKeySet JSONWebKeySet

Defined in ORYHydra.API.Admin

Methods

setBodyParam :: (Consumes UpdateJsonWebKeySet contentType, MimeRender contentType JSONWebKeySet) => ORYHydraRequest UpdateJsonWebKeySet contentType res accept -> JSONWebKeySet -> ORYHydraRequest UpdateJsonWebKeySet contentType res accept

mkJSONWebKeySet :: JSONWebKeySet

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

JsonWebKeySetGeneratorRequest

data JsonWebKeySetGeneratorRequest

JsonWebKeySetGeneratorRequest

Constructors

JsonWebKeySetGeneratorRequest

Fields

• jsonWebKeySetGeneratorRequestAlg :: Text

  Required "alg" - The algorithm to be used for creating the key. Supports "RS256", "ES512", "HS512", and "HS256"

• jsonWebKeySetGeneratorRequestKid :: Text

  Required "kid" - The kid of the key to be created

• jsonWebKeySetGeneratorRequestUse :: Text

  Required "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

Eq JsonWebKeySetGeneratorRequest

Defined in ORYHydra.Model

Methods

(==) :: JsonWebKeySetGeneratorRequest -> JsonWebKeySetGeneratorRequest -> Bool

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

Show JsonWebKeySetGeneratorRequest

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> JsonWebKeySetGeneratorRequest -> ShowS

show :: JsonWebKeySetGeneratorRequest -> String

showList :: [JsonWebKeySetGeneratorRequest] -> ShowS

ToJSON JsonWebKeySetGeneratorRequest

ToJSON JsonWebKeySetGeneratorRequest

Defined in ORYHydra.Model

Methods

toJSON :: JsonWebKeySetGeneratorRequest -> Value

toEncoding :: JsonWebKeySetGeneratorRequest -> Encoding

toJSONList :: [JsonWebKeySetGeneratorRequest] -> Value

toEncodingList :: [JsonWebKeySetGeneratorRequest] -> Encoding

FromJSON JsonWebKeySetGeneratorRequest

FromJSON JsonWebKeySetGeneratorRequest

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser JsonWebKeySetGeneratorRequest

parseJSONList :: Value -> Parser [JsonWebKeySetGeneratorRequest]

HasBodyParam CreateJsonWebKeySet JsonWebKeySetGeneratorRequest

Defined in ORYHydra.API.Admin

Methods

setBodyParam :: (Consumes CreateJsonWebKeySet contentType, MimeRender contentType JsonWebKeySetGeneratorRequest) => ORYHydraRequest CreateJsonWebKeySet contentType res accept -> JsonWebKeySetGeneratorRequest -> ORYHydraRequest CreateJsonWebKeySet contentType res accept

mkJsonWebKeySetGeneratorRequest

Arguments

:: Text

jsonWebKeySetGeneratorRequestAlg: The algorithm to be used for creating the key. Supports "RS256", "ES512", "HS512", and "HS256"

-> Text

jsonWebKeySetGeneratorRequestKid: The kid of the key to be created

-> Text

jsonWebKeySetGeneratorRequestUse: 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".

-> JsonWebKeySetGeneratorRequest

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

LoginRequest

data LoginRequest

LoginRequest Contains information on an ongoing login request.

Constructors

LoginRequest

Fields

• loginRequestChallenge :: Text

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

• loginRequestClient :: OAuth2Client

  Required "client"

• loginRequestOidcContext :: Maybe OpenIDConnectContext

  "oidc_context"

• loginRequestRequestUrl :: 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.

• loginRequestRequestedAccessTokenAudience :: [Text]

  Required "requested_access_token_audience"

• loginRequestRequestedScope :: [Text]

  Required "requested_scope"

• loginRequestSessionId :: 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.

• loginRequestSkip :: 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.

• loginRequestSubject :: 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

Eq LoginRequest

Defined in ORYHydra.Model

Methods

(==) :: LoginRequest -> LoginRequest -> Bool

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

Show LoginRequest

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> LoginRequest -> ShowS

show :: LoginRequest -> String

showList :: [LoginRequest] -> ShowS

ToJSON LoginRequest

ToJSON LoginRequest

Defined in ORYHydra.Model

Methods

toJSON :: LoginRequest -> Value

toEncoding :: LoginRequest -> Encoding

toJSONList :: [LoginRequest] -> Value

toEncodingList :: [LoginRequest] -> Encoding

FromJSON LoginRequest

FromJSON LoginRequest

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser LoginRequest

parseJSONList :: Value -> Parser [LoginRequest]

mkLoginRequest

Arguments

:: Text

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

-> OAuth2Client

loginRequestClient

-> Text

loginRequestRequestUrl: 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]

loginRequestRequestedAccessTokenAudience

-> [Text]

loginRequestRequestedScope

-> Bool

loginRequestSkip: 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

loginRequestSubject: 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.

-> LoginRequest

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

LogoutRequest

data LogoutRequest

LogoutRequest Contains information about an ongoing logout request.

Constructors

LogoutRequest

Fields

• logoutRequestRequestUrl :: Maybe Text

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

• logoutRequestRpInitiated :: 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.

• logoutRequestSid :: Maybe Text

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

• logoutRequestSubject :: Maybe Text

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

Instances

Eq LogoutRequest

Defined in ORYHydra.Model

Methods

(==) :: LogoutRequest -> LogoutRequest -> Bool

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

Show LogoutRequest

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> LogoutRequest -> ShowS

show :: LogoutRequest -> String

showList :: [LogoutRequest] -> ShowS

ToJSON LogoutRequest

ToJSON LogoutRequest

Defined in ORYHydra.Model

Methods

toJSON :: LogoutRequest -> Value

toEncoding :: LogoutRequest -> Encoding

toJSONList :: [LogoutRequest] -> Value

toEncodingList :: [LogoutRequest] -> Encoding

FromJSON LogoutRequest

FromJSON LogoutRequest

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser LogoutRequest

parseJSONList :: Value -> Parser [LogoutRequest]

mkLogoutRequest :: LogoutRequest

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

OAuth2Client

data OAuth2Client

OAuth2Client Client represents an OAuth 2.0 Client.

Constructors

OAuth2Client

Fields

• oAuth2ClientAllowedCorsOrigins :: Maybe [Text]

  "allowed_cors_origins"

• oAuth2ClientAudience :: Maybe [Text]

  "audience"

• oAuth2ClientBackchannelLogoutSessionRequired :: Maybe Bool

  "backchannel_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" - RP URL that will cause the RP to log itself out when sent a Logout Token by the OP.

• oAuth2ClientClientId :: Maybe Text

  "client_id" - ID is the id for this client.

• oAuth2ClientClientName :: Maybe Text

  "client_name" - Name is the human-readable string name of the client to be presented to the end-user during authorization.

• oAuth2ClientClientSecret :: Maybe Text

  "client_secret" - Secret is the client's secret. The secret will be included in the create request as cleartext, and then never again. The secret is stored using BCrypt so it is impossible to recover it. Tell your users that they need to write the secret down as it will not be made available again.

• oAuth2ClientClientSecretExpiresAt :: Maybe Integer

  "client_secret_expires_at" - SecretExpiresAt is an integer holding the time at which the client secret will expire or 0 if it will not expire. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of expiration. This feature is currently not supported and it's value will always be set to 0.

• oAuth2ClientClientUri :: Maybe Text

  "client_uri" - ClientURI is an 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" - CreatedAt returns the timestamp of the client's creation.

• oAuth2ClientFrontchannelLogoutSessionRequired :: Maybe Bool

  "frontchannel_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" - 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"

• oAuth2ClientJwks :: Maybe Value

  "jwks"

• oAuth2ClientJwksUri :: Maybe Text

  "jwks_uri" - 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.

• oAuth2ClientLogoUri :: Maybe Text

  "logo_uri" - LogoURI is an URL string that references a logo for the client.

• oAuth2ClientMetadata :: Maybe Value

  "metadata"

• oAuth2ClientOwner :: Maybe Text

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

• oAuth2ClientPolicyUri :: Maybe Text

  "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"

• oAuth2ClientRequestObjectSigningAlg :: Maybe Text

  "request_object_signing_alg" - 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" - 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" - 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" - SubjectType requested for responses to this Client. 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" - Requested Client Authentication method for the Token Endpoint. The options are client_secret_post, client_secret_basic, private_key_jwt, and none.

• oAuth2ClientTokenEndpointAuthSigningAlg :: Maybe Text

  "token_endpoint_auth_signing_alg" - Requested Client Authentication signing algorithm for the Token Endpoint.

• oAuth2ClientTosUri :: Maybe Text

  "tos_uri" - TermsOfServiceURI is a URL string that points 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" - UpdatedAt returns the timestamp of the last update.

• oAuth2ClientUserinfoSignedResponseAlg :: Maybe Text

  "userinfo_signed_response_alg" - 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

Eq OAuth2Client

Defined in ORYHydra.Model

Methods

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

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

Show OAuth2Client

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> OAuth2Client -> ShowS

show :: OAuth2Client -> String

showList :: [OAuth2Client] -> ShowS

ToJSON OAuth2Client

ToJSON OAuth2Client

Defined in ORYHydra.Model

Methods

toJSON :: OAuth2Client -> Value

toEncoding :: OAuth2Client -> Encoding

toJSONList :: [OAuth2Client] -> Value

toEncodingList :: [OAuth2Client] -> Encoding

FromJSON OAuth2Client

FromJSON OAuth2Client

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser OAuth2Client

parseJSONList :: Value -> Parser [OAuth2Client]

HasBodyParam UpdateOAuth2Client OAuth2Client

Defined in ORYHydra.API.Admin

Methods

setBodyParam :: (Consumes UpdateOAuth2Client contentType, MimeRender contentType OAuth2Client) => ORYHydraRequest UpdateOAuth2Client contentType res accept -> OAuth2Client -> ORYHydraRequest UpdateOAuth2Client contentType res accept

HasBodyParam CreateOAuth2Client OAuth2Client

Defined in ORYHydra.API.Admin

Methods

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

mkOAuth2Client :: OAuth2Client

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

OAuth2TokenIntrospection

data OAuth2TokenIntrospection

OAuth2TokenIntrospection Introspection contains an access token's session data as specified by IETF RFC 7662, see:

https://tools.ietf.org/html/rfc7662

Constructors

OAuth2TokenIntrospection

Fields

• oAuth2TokenIntrospectionActive :: 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).

• oAuth2TokenIntrospectionAud :: Maybe [Text]

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

• oAuth2TokenIntrospectionClientId :: Maybe Text

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

• oAuth2TokenIntrospectionExp :: 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.

• oAuth2TokenIntrospectionExt :: Maybe Value

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

• oAuth2TokenIntrospectionIat :: 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.

• oAuth2TokenIntrospectionIss :: Maybe Text

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

• oAuth2TokenIntrospectionNbf :: 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.

• oAuth2TokenIntrospectionObfuscatedSubject :: 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.

• oAuth2TokenIntrospectionScope :: Maybe Text

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

• oAuth2TokenIntrospectionSub :: 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.

• oAuth2TokenIntrospectionTokenType :: Maybe Text

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

• oAuth2TokenIntrospectionTokenUse :: Maybe Text

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

• oAuth2TokenIntrospectionUsername :: Maybe Text

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

Instances

Eq OAuth2TokenIntrospection

Defined in ORYHydra.Model

Methods

(==) :: OAuth2TokenIntrospection -> OAuth2TokenIntrospection -> Bool

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

Show OAuth2TokenIntrospection

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> OAuth2TokenIntrospection -> ShowS

show :: OAuth2TokenIntrospection -> String

showList :: [OAuth2TokenIntrospection] -> ShowS

ToJSON OAuth2TokenIntrospection

ToJSON OAuth2TokenIntrospection

Defined in ORYHydra.Model

Methods

toJSON :: OAuth2TokenIntrospection -> Value

toEncoding :: OAuth2TokenIntrospection -> Encoding

toJSONList :: [OAuth2TokenIntrospection] -> Value

toEncodingList :: [OAuth2TokenIntrospection] -> Encoding

FromJSON OAuth2TokenIntrospection

FromJSON OAuth2TokenIntrospection

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser OAuth2TokenIntrospection

parseJSONList :: Value -> Parser [OAuth2TokenIntrospection]

mkOAuth2TokenIntrospection

Arguments

:: Bool

oAuth2TokenIntrospectionActive: 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).

-> OAuth2TokenIntrospection

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

Oauth2TokenResponse

data Oauth2TokenResponse

Oauth2TokenResponse The Access Token Response

Constructors

Oauth2TokenResponse

Fields

• oauth2TokenResponseAccessToken :: Maybe Text

  "access_token"

• oauth2TokenResponseExpiresIn :: Maybe Integer

  "expires_in"

• oauth2TokenResponseIdToken :: Maybe Text

  "id_token"

• oauth2TokenResponseRefreshToken :: Maybe Text

  "refresh_token"

• oauth2TokenResponseScope :: Maybe Text

  "scope"

• oauth2TokenResponseTokenType :: Maybe Text

  "token_type"

Instances

Eq Oauth2TokenResponse

Defined in ORYHydra.Model

Methods

(==) :: Oauth2TokenResponse -> Oauth2TokenResponse -> Bool

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

Show Oauth2TokenResponse

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> Oauth2TokenResponse -> ShowS

show :: Oauth2TokenResponse -> String

showList :: [Oauth2TokenResponse] -> ShowS

ToJSON Oauth2TokenResponse

ToJSON Oauth2TokenResponse

Defined in ORYHydra.Model

Methods

toJSON :: Oauth2TokenResponse -> Value

toEncoding :: Oauth2TokenResponse -> Encoding

toJSONList :: [Oauth2TokenResponse] -> Value

toEncodingList :: [Oauth2TokenResponse] -> Encoding

FromJSON Oauth2TokenResponse

FromJSON Oauth2TokenResponse

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser Oauth2TokenResponse

parseJSONList :: Value -> Parser [Oauth2TokenResponse]

mkOauth2TokenResponse :: Oauth2TokenResponse

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

OpenIDConnectContext

data OpenIDConnectContext

OpenIDConnectContext Contains optional information about the OpenID Connect request.

Constructors

OpenIDConnectContext

Fields

• openIDConnectContextAcrValues :: 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.

• openIDConnectContextDisplay :: 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.

• openIDConnectContextIdTokenHintClaims :: Maybe 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.

• openIDConnectContextLoginHint :: 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.

• openIDConnectContextUiLocales :: 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

Eq OpenIDConnectContext

Defined in ORYHydra.Model

Methods

(==) :: OpenIDConnectContext -> OpenIDConnectContext -> Bool

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

Show OpenIDConnectContext

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> OpenIDConnectContext -> ShowS

show :: OpenIDConnectContext -> String

showList :: [OpenIDConnectContext] -> ShowS

ToJSON OpenIDConnectContext

ToJSON OpenIDConnectContext

Defined in ORYHydra.Model

Methods

toJSON :: OpenIDConnectContext -> Value

toEncoding :: OpenIDConnectContext -> Encoding

toJSONList :: [OpenIDConnectContext] -> Value

toEncodingList :: [OpenIDConnectContext] -> Encoding

FromJSON OpenIDConnectContext

FromJSON OpenIDConnectContext

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser OpenIDConnectContext

parseJSONList :: Value -> Parser [OpenIDConnectContext]

mkOpenIDConnectContext :: OpenIDConnectContext

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

PluginConfig

data PluginConfig

PluginConfig PluginConfig The config of a plugin.

Constructors

PluginConfig

Fields

• pluginConfigArgs :: PluginConfigArgs

  Required Args

• pluginConfigDescription :: Text

  Required Description - description

• pluginConfigDockerVersion :: Maybe Text

  DockerVersion - Docker Version used to create the plugin

• pluginConfigDocumentation :: Text

  Required Documentation - documentation

• pluginConfigEntrypoint :: [Text]

  Required Entrypoint - entrypoint

• pluginConfigEnv :: [PluginEnv]

  Required Env - env

• pluginConfigInterface :: PluginConfigInterface

  Required Interface

• pluginConfigIpcHost :: Bool

  Required IpcHost - ipc host

• pluginConfigLinux :: PluginConfigLinux

  Required Linux

• pluginConfigMounts :: [PluginMount]

  Required Mounts - mounts

• pluginConfigNetwork :: PluginConfigNetwork

  Required Network

• pluginConfigPidHost :: Bool

  Required PidHost - pid host

• pluginConfigPropagatedMount :: Text

  Required PropagatedMount - propagated mount

• pluginConfigUser :: Maybe PluginConfigUser

  User

• pluginConfigWorkDir :: Text

  Required WorkDir - work dir

• pluginConfigRootfs :: Maybe PluginConfigRootfs

  "rootfs"

Instances

Eq PluginConfig

Defined in ORYHydra.Model

Methods

(==) :: PluginConfig -> PluginConfig -> Bool

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

Show PluginConfig

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> PluginConfig -> ShowS

show :: PluginConfig -> String

showList :: [PluginConfig] -> ShowS

ToJSON PluginConfig

ToJSON PluginConfig

Defined in ORYHydra.Model

Methods

toJSON :: PluginConfig -> Value

toEncoding :: PluginConfig -> Encoding

toJSONList :: [PluginConfig] -> Value

toEncodingList :: [PluginConfig] -> Encoding

FromJSON PluginConfig

FromJSON PluginConfig

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser PluginConfig

parseJSONList :: Value -> Parser [PluginConfig]

mkPluginConfig

Arguments

:: PluginConfigArgs

pluginConfigArgs

-> Text

pluginConfigDescription: description

-> Text

pluginConfigDocumentation: documentation

-> [Text]

pluginConfigEntrypoint: entrypoint

-> [PluginEnv]

pluginConfigEnv: env

-> PluginConfigInterface

pluginConfigInterface

-> Bool

pluginConfigIpcHost: ipc host

-> PluginConfigLinux

pluginConfigLinux

-> [PluginMount]

pluginConfigMounts: mounts

-> PluginConfigNetwork

pluginConfigNetwork

-> Bool

pluginConfigPidHost: pid host

-> Text

pluginConfigPropagatedMount: propagated mount

-> Text

pluginConfigWorkDir: work dir

-> PluginConfig

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

PluginConfigArgs

data PluginConfigArgs

PluginConfigArgs PluginConfigArgs plugin config args

Constructors

PluginConfigArgs

Fields

• pluginConfigArgsDescription :: Text

  Required Description - description

• pluginConfigArgsName :: Text

  Required Name - name

• pluginConfigArgsSettable :: [Text]

  Required Settable - settable

• pluginConfigArgsValue :: [Text]

  Required Value - value

Instances

Eq PluginConfigArgs

Defined in ORYHydra.Model

Methods

(==) :: PluginConfigArgs -> PluginConfigArgs -> Bool

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

Show PluginConfigArgs

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> PluginConfigArgs -> ShowS

show :: PluginConfigArgs -> String

showList :: [PluginConfigArgs] -> ShowS

ToJSON PluginConfigArgs

ToJSON PluginConfigArgs

Defined in ORYHydra.Model

Methods

toJSON :: PluginConfigArgs -> Value

toEncoding :: PluginConfigArgs -> Encoding

toJSONList :: [PluginConfigArgs] -> Value

toEncodingList :: [PluginConfigArgs] -> Encoding

FromJSON PluginConfigArgs

FromJSON PluginConfigArgs

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser PluginConfigArgs

parseJSONList :: Value -> Parser [PluginConfigArgs]

mkPluginConfigArgs

Arguments

:: Text

pluginConfigArgsDescription: description

-> Text

pluginConfigArgsName: name

-> [Text]

pluginConfigArgsSettable: settable

-> [Text]

pluginConfigArgsValue: value

-> PluginConfigArgs

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

PluginConfigInterface

data PluginConfigInterface

PluginConfigInterface PluginConfigInterface The interface between Docker and the plugin

Constructors

PluginConfigInterface

Fields

• pluginConfigInterfaceProtocolScheme :: Maybe Text

  ProtocolScheme - Protocol to use for clients connecting to the plugin.

• pluginConfigInterfaceSocket :: Text

  Required Socket - socket

• pluginConfigInterfaceTypes :: [PluginInterfaceType]

  Required Types - types

Instances

Eq PluginConfigInterface

Defined in ORYHydra.Model

Methods

(==) :: PluginConfigInterface -> PluginConfigInterface -> Bool

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

Show PluginConfigInterface

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> PluginConfigInterface -> ShowS

show :: PluginConfigInterface -> String

showList :: [PluginConfigInterface] -> ShowS

ToJSON PluginConfigInterface

ToJSON PluginConfigInterface

Defined in ORYHydra.Model

Methods

toJSON :: PluginConfigInterface -> Value

toEncoding :: PluginConfigInterface -> Encoding

toJSONList :: [PluginConfigInterface] -> Value

toEncodingList :: [PluginConfigInterface] -> Encoding

FromJSON PluginConfigInterface

FromJSON PluginConfigInterface

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser PluginConfigInterface

parseJSONList :: Value -> Parser [PluginConfigInterface]

mkPluginConfigInterface

Arguments

:: Text

pluginConfigInterfaceSocket: socket

-> [PluginInterfaceType]

pluginConfigInterfaceTypes: types

-> PluginConfigInterface

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

PluginConfigLinux

data PluginConfigLinux

PluginConfigLinux PluginConfigLinux plugin config linux

Constructors

PluginConfigLinux

Fields

• pluginConfigLinuxAllowAllDevices :: Bool

  Required AllowAllDevices - allow all devices

• pluginConfigLinuxCapabilities :: [Text]

  Required Capabilities - capabilities

• pluginConfigLinuxDevices :: [PluginDevice]

  Required Devices - devices

Instances

Eq PluginConfigLinux

Defined in ORYHydra.Model

Methods

(==) :: PluginConfigLinux -> PluginConfigLinux -> Bool

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

Show PluginConfigLinux

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> PluginConfigLinux -> ShowS

show :: PluginConfigLinux -> String

showList :: [PluginConfigLinux] -> ShowS

ToJSON PluginConfigLinux

ToJSON PluginConfigLinux

Defined in ORYHydra.Model

Methods

toJSON :: PluginConfigLinux -> Value

toEncoding :: PluginConfigLinux -> Encoding

toJSONList :: [PluginConfigLinux] -> Value

toEncodingList :: [PluginConfigLinux] -> Encoding

FromJSON PluginConfigLinux

FromJSON PluginConfigLinux

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser PluginConfigLinux

parseJSONList :: Value -> Parser [PluginConfigLinux]

mkPluginConfigLinux

Arguments

:: Bool

pluginConfigLinuxAllowAllDevices: allow all devices

-> [Text]

pluginConfigLinuxCapabilities: capabilities

-> [PluginDevice]

pluginConfigLinuxDevices: devices

-> PluginConfigLinux

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

PluginConfigNetwork

data PluginConfigNetwork

PluginConfigNetwork PluginConfigNetwork plugin config network

Constructors

PluginConfigNetwork

Fields

• pluginConfigNetworkType :: Text

  Required Type - type

Instances

Eq PluginConfigNetwork

Defined in ORYHydra.Model

Methods

(==) :: PluginConfigNetwork -> PluginConfigNetwork -> Bool

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

Show PluginConfigNetwork

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> PluginConfigNetwork -> ShowS

show :: PluginConfigNetwork -> String

showList :: [PluginConfigNetwork] -> ShowS

ToJSON PluginConfigNetwork

ToJSON PluginConfigNetwork

Defined in ORYHydra.Model

Methods

toJSON :: PluginConfigNetwork -> Value

toEncoding :: PluginConfigNetwork -> Encoding

toJSONList :: [PluginConfigNetwork] -> Value

toEncodingList :: [PluginConfigNetwork] -> Encoding

FromJSON PluginConfigNetwork

FromJSON PluginConfigNetwork

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser PluginConfigNetwork

parseJSONList :: Value -> Parser [PluginConfigNetwork]

mkPluginConfigNetwork

Arguments

:: Text

pluginConfigNetworkType: type

-> PluginConfigNetwork

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

PluginConfigRootfs

data PluginConfigRootfs

PluginConfigRootfs PluginConfigRootfs plugin config rootfs

Constructors

PluginConfigRootfs

Fields

• pluginConfigRootfsDiffIds :: Maybe [Text]

  "diff_ids" - diff ids

• pluginConfigRootfsType :: Maybe Text

  "type" - type

Instances

Eq PluginConfigRootfs

Defined in ORYHydra.Model

Methods

(==) :: PluginConfigRootfs -> PluginConfigRootfs -> Bool

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

Show PluginConfigRootfs

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> PluginConfigRootfs -> ShowS

show :: PluginConfigRootfs -> String

showList :: [PluginConfigRootfs] -> ShowS

ToJSON PluginConfigRootfs

ToJSON PluginConfigRootfs

Defined in ORYHydra.Model

Methods

toJSON :: PluginConfigRootfs -> Value

toEncoding :: PluginConfigRootfs -> Encoding

toJSONList :: [PluginConfigRootfs] -> Value

toEncodingList :: [PluginConfigRootfs] -> Encoding

FromJSON PluginConfigRootfs

FromJSON PluginConfigRootfs

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser PluginConfigRootfs

parseJSONList :: Value -> Parser [PluginConfigRootfs]

mkPluginConfigRootfs :: PluginConfigRootfs

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

PluginConfigUser

data PluginConfigUser

PluginConfigUser PluginConfigUser plugin config user

Constructors

PluginConfigUser

Fields

• pluginConfigUserGid :: Maybe Int

  GID - g ID

• pluginConfigUserUid :: Maybe Int

  UID - UID

Instances

Eq PluginConfigUser

Defined in ORYHydra.Model

Methods

(==) :: PluginConfigUser -> PluginConfigUser -> Bool

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

Show PluginConfigUser

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> PluginConfigUser -> ShowS

show :: PluginConfigUser -> String

showList :: [PluginConfigUser] -> ShowS

ToJSON PluginConfigUser

ToJSON PluginConfigUser

Defined in ORYHydra.Model

Methods

toJSON :: PluginConfigUser -> Value

toEncoding :: PluginConfigUser -> Encoding

toJSONList :: [PluginConfigUser] -> Value

toEncodingList :: [PluginConfigUser] -> Encoding

FromJSON PluginConfigUser

FromJSON PluginConfigUser

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser PluginConfigUser

parseJSONList :: Value -> Parser [PluginConfigUser]

mkPluginConfigUser :: PluginConfigUser

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

PluginDevice

data PluginDevice

PluginDevice PluginDevice plugin device

Constructors

PluginDevice

Fields

• pluginDeviceDescription :: Text

  Required Description - description

• pluginDeviceName :: Text

  Required Name - name

• pluginDevicePath :: Text

  Required Path - path

• pluginDeviceSettable :: [Text]

  Required Settable - settable

Instances

Eq PluginDevice

Defined in ORYHydra.Model

Methods

(==) :: PluginDevice -> PluginDevice -> Bool

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

Show PluginDevice

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> PluginDevice -> ShowS

show :: PluginDevice -> String

showList :: [PluginDevice] -> ShowS

ToJSON PluginDevice

ToJSON PluginDevice

Defined in ORYHydra.Model

Methods

toJSON :: PluginDevice -> Value

toEncoding :: PluginDevice -> Encoding

toJSONList :: [PluginDevice] -> Value

toEncodingList :: [PluginDevice] -> Encoding

FromJSON PluginDevice

FromJSON PluginDevice

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser PluginDevice

parseJSONList :: Value -> Parser [PluginDevice]

mkPluginDevice

Arguments

:: Text

pluginDeviceDescription: description

-> Text

pluginDeviceName: name

-> Text

pluginDevicePath: path

-> [Text]

pluginDeviceSettable: settable

-> PluginDevice

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

PluginEnv

data PluginEnv

PluginEnv PluginEnv plugin env

Constructors

PluginEnv

Fields

• pluginEnvDescription :: Text

  Required Description - description

• pluginEnvName :: Text

  Required Name - name

• pluginEnvSettable :: [Text]

  Required Settable - settable

• pluginEnvValue :: Text

  Required Value - value

Instances

Eq PluginEnv

Defined in ORYHydra.Model

Methods

(==) :: PluginEnv -> PluginEnv -> Bool

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

Show PluginEnv

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> PluginEnv -> ShowS

show :: PluginEnv -> String

showList :: [PluginEnv] -> ShowS

ToJSON PluginEnv

ToJSON PluginEnv

Defined in ORYHydra.Model

Methods

toJSON :: PluginEnv -> Value

toEncoding :: PluginEnv -> Encoding

toJSONList :: [PluginEnv] -> Value

toEncodingList :: [PluginEnv] -> Encoding

FromJSON PluginEnv

FromJSON PluginEnv

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser PluginEnv

parseJSONList :: Value -> Parser [PluginEnv]

mkPluginEnv

Arguments

:: Text

pluginEnvDescription: description

-> Text

pluginEnvName: name

-> [Text]

pluginEnvSettable: settable

-> Text

pluginEnvValue: value

-> PluginEnv

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

PluginInterfaceType

data PluginInterfaceType

PluginInterfaceType PluginInterfaceType plugin interface type

Constructors

PluginInterfaceType

Fields

• pluginInterfaceTypeCapability :: Text

  Required Capability - capability

• pluginInterfaceTypePrefix :: Text

  Required Prefix - prefix

• pluginInterfaceTypeVersion :: Text

  Required Version - version

Instances

Eq PluginInterfaceType

Defined in ORYHydra.Model

Methods

(==) :: PluginInterfaceType -> PluginInterfaceType -> Bool

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

Show PluginInterfaceType

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> PluginInterfaceType -> ShowS

show :: PluginInterfaceType -> String

showList :: [PluginInterfaceType] -> ShowS

ToJSON PluginInterfaceType

ToJSON PluginInterfaceType

Defined in ORYHydra.Model

Methods

toJSON :: PluginInterfaceType -> Value

toEncoding :: PluginInterfaceType -> Encoding

toJSONList :: [PluginInterfaceType] -> Value

toEncodingList :: [PluginInterfaceType] -> Encoding

FromJSON PluginInterfaceType

FromJSON PluginInterfaceType

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser PluginInterfaceType

parseJSONList :: Value -> Parser [PluginInterfaceType]

mkPluginInterfaceType

Arguments

:: Text

pluginInterfaceTypeCapability: capability

-> Text

pluginInterfaceTypePrefix: prefix

-> Text

pluginInterfaceTypeVersion: version

-> PluginInterfaceType

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

PluginMount

data PluginMount

PluginMount PluginMount plugin mount

Constructors

PluginMount

Fields

• pluginMountDescription :: Text

  Required Description - description

• pluginMountDestination :: Text

  Required Destination - destination

• pluginMountName :: Text

  Required Name - name

• pluginMountOptions :: [Text]

  Required Options - options

• pluginMountSettable :: [Text]

  Required Settable - settable

• pluginMountSource :: Text

  Required Source - source

• pluginMountType :: Text

  Required Type - type

Instances

Eq PluginMount

Defined in ORYHydra.Model

Methods

(==) :: PluginMount -> PluginMount -> Bool

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

Show PluginMount

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> PluginMount -> ShowS

show :: PluginMount -> String

showList :: [PluginMount] -> ShowS

ToJSON PluginMount

ToJSON PluginMount

Defined in ORYHydra.Model

Methods

toJSON :: PluginMount -> Value

toEncoding :: PluginMount -> Encoding

toJSONList :: [PluginMount] -> Value

toEncodingList :: [PluginMount] -> Encoding

FromJSON PluginMount

FromJSON PluginMount

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser PluginMount

parseJSONList :: Value -> Parser [PluginMount]

mkPluginMount

Arguments

:: Text

pluginMountDescription: description

-> Text

pluginMountDestination: destination

-> Text

pluginMountName: name

-> [Text]

pluginMountOptions: options

-> [Text]

pluginMountSettable: settable

-> Text

pluginMountSource: source

-> Text

pluginMountType: type

-> PluginMount

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

PluginSettings

data PluginSettings

PluginSettings PluginSettings Settings that can be modified by users.

Constructors

PluginSettings

Fields

• pluginSettingsArgs :: [Text]

  Required Args - args

• pluginSettingsDevices :: [PluginDevice]

  Required Devices - devices

• pluginSettingsEnv :: [Text]

  Required Env - env

• pluginSettingsMounts :: [PluginMount]

  Required Mounts - mounts

Instances

Eq PluginSettings

Defined in ORYHydra.Model

Methods

(==) :: PluginSettings -> PluginSettings -> Bool

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

Show PluginSettings

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> PluginSettings -> ShowS

show :: PluginSettings -> String

showList :: [PluginSettings] -> ShowS

ToJSON PluginSettings

ToJSON PluginSettings

Defined in ORYHydra.Model

Methods

toJSON :: PluginSettings -> Value

toEncoding :: PluginSettings -> Encoding

toJSONList :: [PluginSettings] -> Value

toEncodingList :: [PluginSettings] -> Encoding

FromJSON PluginSettings

FromJSON PluginSettings

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser PluginSettings

parseJSONList :: Value -> Parser [PluginSettings]

mkPluginSettings

Arguments

:: [Text]

pluginSettingsArgs: args

-> [PluginDevice]

pluginSettingsDevices: devices

-> [Text]

pluginSettingsEnv: env

-> [PluginMount]

pluginSettingsMounts: mounts

-> PluginSettings

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

PreviousConsentSession

data PreviousConsentSession

PreviousConsentSession The response used to return used consent requests same as HandledLoginRequest, just with consent_request exposed as json

Constructors

PreviousConsentSession

Fields

• previousConsentSessionConsentRequest :: Maybe ConsentRequest

  "consent_request"

• previousConsentSessionGrantAccessTokenAudience :: Maybe [Text]

  "grant_access_token_audience"

• previousConsentSessionGrantScope :: Maybe [Text]

  "grant_scope"

• previousConsentSessionHandledAt :: Maybe DateTime

  "handled_at"

• previousConsentSessionRemember :: 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.

• previousConsentSessionRememberFor :: 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.

• previousConsentSessionSession :: Maybe ConsentRequestSession

  "session"

Instances

Eq PreviousConsentSession

Defined in ORYHydra.Model

Methods

(==) :: PreviousConsentSession -> PreviousConsentSession -> Bool

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

Show PreviousConsentSession

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> PreviousConsentSession -> ShowS

show :: PreviousConsentSession -> String

showList :: [PreviousConsentSession] -> ShowS

ToJSON PreviousConsentSession

ToJSON PreviousConsentSession

Defined in ORYHydra.Model

Methods

toJSON :: PreviousConsentSession -> Value

toEncoding :: PreviousConsentSession -> Encoding

toJSONList :: [PreviousConsentSession] -> Value

toEncodingList :: [PreviousConsentSession] -> Encoding

FromJSON PreviousConsentSession

FromJSON PreviousConsentSession

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser PreviousConsentSession

parseJSONList :: Value -> Parser [PreviousConsentSession]

mkPreviousConsentSession :: PreviousConsentSession

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

RejectRequest

data RejectRequest

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

Constructors

RejectRequest

Fields

• rejectRequestError :: Maybe Text

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

• rejectRequestErrorDebug :: 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.

• rejectRequestErrorDescription :: Maybe Text

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

• rejectRequestErrorHint :: Maybe Text

  "error_hint" - Hint to help resolve the error.

• rejectRequestStatusCode :: Maybe Integer

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

Instances

Eq RejectRequest

Defined in ORYHydra.Model

Methods

(==) :: RejectRequest -> RejectRequest -> Bool

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

Show RejectRequest

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> RejectRequest -> ShowS

show :: RejectRequest -> String

showList :: [RejectRequest] -> ShowS

ToJSON RejectRequest

ToJSON RejectRequest

Defined in ORYHydra.Model

Methods

toJSON :: RejectRequest -> Value

toEncoding :: RejectRequest -> Encoding

toJSONList :: [RejectRequest] -> Value

toEncodingList :: [RejectRequest] -> Encoding

FromJSON RejectRequest

FromJSON RejectRequest

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser RejectRequest

parseJSONList :: Value -> Parser [RejectRequest]

ToForm RejectRequest

ToForm RejectRequest

Defined in ORYHydra.Model

Methods

toForm :: RejectRequest -> Form

FromForm RejectRequest

FromForm RejectRequest

Defined in ORYHydra.Model

Methods

fromForm :: Form -> Either Text RejectRequest

HasBodyParam RejectLogoutRequest RejectRequest

Defined in ORYHydra.API.Admin

Methods

setBodyParam :: (Consumes RejectLogoutRequest contentType, MimeRender contentType RejectRequest) => ORYHydraRequest RejectLogoutRequest contentType res accept -> RejectRequest -> ORYHydraRequest RejectLogoutRequest contentType res accept

HasBodyParam RejectLoginRequest RejectRequest

Defined in ORYHydra.API.Admin

Methods

setBodyParam :: (Consumes RejectLoginRequest contentType, MimeRender contentType RejectRequest) => ORYHydraRequest RejectLoginRequest contentType res accept -> RejectRequest -> ORYHydraRequest RejectLoginRequest contentType res accept

HasBodyParam RejectConsentRequest RejectRequest

Defined in ORYHydra.API.Admin

Methods

setBodyParam :: (Consumes RejectConsentRequest contentType, MimeRender contentType RejectRequest) => ORYHydraRequest RejectConsentRequest contentType res accept -> RejectRequest -> ORYHydraRequest RejectConsentRequest contentType res accept

mkRejectRequest :: RejectRequest

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

UserinfoResponse

data UserinfoResponse

UserinfoResponse The userinfo response

Constructors

UserinfoResponse

Fields

• userinfoResponseBirthdate :: 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.

• userinfoResponseEmail :: 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.

• userinfoResponseEmailVerified :: 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.

• userinfoResponseFamilyName :: 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.

• userinfoResponseGender :: 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.

• userinfoResponseGivenName :: 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.

• userinfoResponseLocale :: 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.

• userinfoResponseMiddleName :: 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.

• userinfoResponseName :: 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.

• userinfoResponseNickname :: 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.

• userinfoResponsePhoneNumber :: 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.

• userinfoResponsePhoneNumberVerified :: 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.

• userinfoResponsePicture :: 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.

• userinfoResponsePreferredUsername :: 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.

• userinfoResponseProfile :: Maybe Text

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

• userinfoResponseSub :: Maybe Text

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

• userinfoResponseUpdatedAt :: 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.

• userinfoResponseWebsite :: 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.

• userinfoResponseZoneinfo :: Maybe Text

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

Instances

Eq UserinfoResponse

Defined in ORYHydra.Model

Methods

(==) :: UserinfoResponse -> UserinfoResponse -> Bool

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

Show UserinfoResponse

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> UserinfoResponse -> ShowS

show :: UserinfoResponse -> String

showList :: [UserinfoResponse] -> ShowS

ToJSON UserinfoResponse

ToJSON UserinfoResponse

Defined in ORYHydra.Model

Methods

toJSON :: UserinfoResponse -> Value

toEncoding :: UserinfoResponse -> Encoding

toJSONList :: [UserinfoResponse] -> Value

toEncodingList :: [UserinfoResponse] -> Encoding

FromJSON UserinfoResponse

FromJSON UserinfoResponse

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser UserinfoResponse

parseJSONList :: Value -> Parser [UserinfoResponse]

mkUserinfoResponse :: UserinfoResponse

Construct a value of type UserinfoResponse (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

Eq Version

Defined in ORYHydra.Model

Methods

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

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

Show Version

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> Version -> ShowS

show :: Version -> String

showList :: [Version] -> ShowS

ToJSON Version

ToJSON Version

Defined in ORYHydra.Model

Methods

toJSON :: Version -> Value

toEncoding :: Version -> Encoding

toJSONList :: [Version] -> Value

toEncodingList :: [Version] -> Encoding

FromJSON Version

FromJSON Version

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser Version

parseJSONList :: Value -> Parser [Version]

mkVersion :: Version

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

Volume

data Volume

Volume Volume volume

Constructors

Volume

Fields

• volumeCreatedAt :: Maybe Text

  CreatedAt - Date/Time the volume was created.

• volumeDriver :: Text

  Required Driver - Name of the volume driver used by the volume.

• volumeLabels :: Map String Text

  Required Labels - User-defined key/value metadata.

• volumeMountpoint :: Text

  Required Mountpoint - Mount path of the volume on the host.

• volumeName :: Text

  Required Name - Name of the volume.

• volumeOptions :: Map String Text

  Required Options - The driver specific options used when creating the volume.

• volumeScope :: Text

  Required Scope - The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level.

• volumeStatus :: Maybe Value

  Status - Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{"key":"value","key2":"value2"}`. The `Status` field is optional, and is omitted if the volume driver does not support this feature.

• volumeUsageData :: Maybe VolumeUsageData

  UsageData

Instances

Eq Volume

Defined in ORYHydra.Model

Methods

(==) :: Volume -> Volume -> Bool

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

Show Volume

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> Volume -> ShowS

show :: Volume -> String

showList :: [Volume] -> ShowS

ToJSON Volume

ToJSON Volume

Defined in ORYHydra.Model

Methods

toJSON :: Volume -> Value

toEncoding :: Volume -> Encoding

toJSONList :: [Volume] -> Value

toEncodingList :: [Volume] -> Encoding

FromJSON Volume

FromJSON Volume

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser Volume

parseJSONList :: Value -> Parser [Volume]

mkVolume

Arguments

:: Text

volumeDriver: Name of the volume driver used by the volume.

-> Map String Text

volumeLabels: User-defined key/value metadata.

-> Text

volumeMountpoint: Mount path of the volume on the host.

-> Text

volumeName: Name of the volume.

-> Map String Text

volumeOptions: The driver specific options used when creating the volume.

-> Text

volumeScope: The level at which the volume exists. Either global for cluster-wide, or local for machine level.

-> Volume

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

VolumeUsageData

data VolumeUsageData

VolumeUsageData VolumeUsageData Usage details about the volume. This information is used by the `GET systemdf` endpoint, and omitted in other endpoints.

Constructors

VolumeUsageData

Fields

• volumeUsageDataRefCount :: Integer

  Required RefCount - The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available.

• volumeUsageDataSize :: Integer

  Required Size - Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `"local"` volume driver. For volumes created with other volume drivers, this field is set to `-1` ("not available")

Instances

Eq VolumeUsageData

Defined in ORYHydra.Model

Methods

(==) :: VolumeUsageData -> VolumeUsageData -> Bool

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

Show VolumeUsageData

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> VolumeUsageData -> ShowS

show :: VolumeUsageData -> String

showList :: [VolumeUsageData] -> ShowS

ToJSON VolumeUsageData

ToJSON VolumeUsageData

Defined in ORYHydra.Model

Methods

toJSON :: VolumeUsageData -> Value

toEncoding :: VolumeUsageData -> Encoding

toJSONList :: [VolumeUsageData] -> Value

toEncodingList :: [VolumeUsageData] -> Encoding

FromJSON VolumeUsageData

FromJSON VolumeUsageData

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser VolumeUsageData

parseJSONList :: Value -> Parser [VolumeUsageData]

mkVolumeUsageData

Arguments

:: Integer

volumeUsageDataRefCount: The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available.

-> Integer

volumeUsageDataSize: Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `"local"` volume driver. For volumes created with other volume drivers, this field is set to `-1` ("not available")

-> VolumeUsageData

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

WellKnown

data WellKnown

WellKnown WellKnown represents important OpenID Connect discovery metadata

It includes links to several endpoints (e.g. oauth2token) and exposes information on supported signature algorithms among others.

Constructors

WellKnown

Fields

• wellKnownAuthorizationEndpoint :: Text

  Required "authorization_endpoint" - URL of the OP's OAuth 2.0 Authorization Endpoint.

• wellKnownBackchannelLogoutSessionSupported :: Maybe Bool

  "backchannel_logout_session_supported" - 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

• wellKnownBackchannelLogoutSupported :: Maybe Bool

  "backchannel_logout_supported" - Boolean value specifying whether the OP supports back-channel logout, with true indicating support.

• wellKnownClaimsParameterSupported :: Maybe Bool

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

• wellKnownClaimsSupported :: Maybe [Text]

  "claims_supported" - 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.

• wellKnownEndSessionEndpoint :: Maybe Text

  "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.

• wellKnownFrontchannelLogoutSessionSupported :: Maybe Bool

  "frontchannel_logout_session_supported" - 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.

• wellKnownFrontchannelLogoutSupported :: Maybe Bool

  "frontchannel_logout_supported" - Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support.

• wellKnownGrantTypesSupported :: Maybe [Text]

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

• wellKnownIdTokenSigningAlgValuesSupported :: [Text]

  Required "id_token_signing_alg_values_supported" - 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.

• wellKnownIssuer :: Text

  Required "issuer" - 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.

• wellKnownJwksUri :: Text

  Required "jwks_uri" - 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.

• wellKnownRegistrationEndpoint :: Maybe Text

  "registration_endpoint" - URL of the OP's Dynamic Client Registration Endpoint.

• wellKnownRequestObjectSigningAlgValuesSupported :: Maybe [Text]

  "request_object_signing_alg_values_supported" - 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).

• wellKnownRequestParameterSupported :: Maybe Bool

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

• wellKnownRequestUriParameterSupported :: Maybe Bool

  "request_uri_parameter_supported" - Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.

• wellKnownRequireRequestUriRegistration :: Maybe Bool

  "require_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.

• wellKnownResponseModesSupported :: Maybe [Text]

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

• wellKnownResponseTypesSupported :: [Text]

  Required "response_types_supported" - 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.

• wellKnownRevocationEndpoint :: Maybe Text

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

• wellKnownScopesSupported :: Maybe [Text]

  "scopes_supported" - SON 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

• wellKnownSubjectTypesSupported :: [Text]

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

• wellKnownTokenEndpoint :: Text

  Required "token_endpoint" - URL of the OP's OAuth 2.0 Token Endpoint

• wellKnownTokenEndpointAuthMethodsSupported :: Maybe [Text]

  "token_endpoint_auth_methods_supported" - 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

• wellKnownUserinfoEndpoint :: Maybe Text

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

• wellKnownUserinfoSigningAlgValuesSupported :: Maybe [Text]

  "userinfo_signing_alg_values_supported" - 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

Eq WellKnown

Defined in ORYHydra.Model

Methods

(==) :: WellKnown -> WellKnown -> Bool

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

Show WellKnown

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> WellKnown -> ShowS

show :: WellKnown -> String

showList :: [WellKnown] -> ShowS

ToJSON WellKnown

ToJSON WellKnown

Defined in ORYHydra.Model

Methods

toJSON :: WellKnown -> Value

toEncoding :: WellKnown -> Encoding

toJSONList :: [WellKnown] -> Value

toEncodingList :: [WellKnown] -> Encoding

FromJSON WellKnown

FromJSON WellKnown

Defined in ORYHydra.Model

Methods

parseJSON :: Value -> Parser WellKnown

parseJSONList :: Value -> Parser [WellKnown]

mkWellKnown

Arguments

:: Text

wellKnownAuthorizationEndpoint: URL of the OP's OAuth 2.0 Authorization Endpoint.

-> [Text]

wellKnownIdTokenSigningAlgValuesSupported: 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

wellKnownIssuer: 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

wellKnownJwksUri: 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]

wellKnownResponseTypesSupported: 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]

wellKnownSubjectTypesSupported: JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public.

-> Text

wellKnownTokenEndpoint: URL of the OP's OAuth 2.0 Token Endpoint

-> WellKnown

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

Auth Methods

AuthBasicBasic

data AuthBasicBasic

Constructors

AuthBasicBasic ByteString ByteString

username password

Instances

Eq AuthBasicBasic

Defined in ORYHydra.Model

Methods

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

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

Show AuthBasicBasic

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> AuthBasicBasic -> ShowS

show :: AuthBasicBasic -> String

showList :: [AuthBasicBasic] -> ShowS

AuthMethod AuthBasicBasic

Defined in ORYHydra.Model

Methods

applyAuthMethod :: ORYHydraConfig -> AuthBasicBasic -> ORYHydraRequest req contentType res accept -> IO (ORYHydraRequest req contentType res accept)

AuthOAuthOauth2

data AuthOAuthOauth2

Constructors

AuthOAuthOauth2 Text

secret

Instances

Eq AuthOAuthOauth2

Defined in ORYHydra.Model

Methods

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

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

Show AuthOAuthOauth2

Defined in ORYHydra.Model

Methods

showsPrec :: Int -> AuthOAuthOauth2 -> ShowS

show :: AuthOAuthOauth2 -> String

showList :: [AuthOAuthOauth2] -> ShowS

AuthMethod AuthOAuthOauth2

Defined in ORYHydra.Model

Methods

applyAuthMethod :: ORYHydraConfig -> AuthOAuthOauth2 -> ORYHydraRequest req contentType res accept -> IO (ORYHydraRequest req contentType res accept)