Liking cljdoc? Tell your friends :D
Clojure only.

active.clojure.openid


access-token-expiresclj

(access-token-expires rec__3071__auto__)
(access-token-expires data__3072__auto__ v__3073__auto__)

Lens for the expires field from a [[AccessToken]] record. See active.clojure.openid/make-access-token.

Lens for the `expires` field from a [[AccessToken]] record. See [[active.clojure.openid/make-access-token]].
raw docstring

access-token-extra-dataclj

(access-token-extra-data rec__3071__auto__)
(access-token-extra-data data__3072__auto__ v__3073__auto__)

Lens for the extra-data field from a [[AccessToken]] record. See active.clojure.openid/make-access-token.

Lens for the `extra-data` field from a [[AccessToken]] record. See [[active.clojure.openid/make-access-token]].
raw docstring

access-token-id-tokenclj

(access-token-id-token rec__3071__auto__)
(access-token-id-token data__3072__auto__ v__3073__auto__)

Lens for the id-token field from a [[AccessToken]] record. See active.clojure.openid/make-access-token.

Lens for the `id-token` field from a [[AccessToken]] record. See [[active.clojure.openid/make-access-token]].
raw docstring

access-token-projection-lensclj


access-token-refresh-expiresclj

(access-token-refresh-expires rec__3071__auto__)
(access-token-refresh-expires data__3072__auto__ v__3073__auto__)

Lens for the refresh-expires field from a [[AccessToken]] record. See active.clojure.openid/make-access-token.

Lens for the `refresh-expires` field from a [[AccessToken]] record. See [[active.clojure.openid/make-access-token]].
raw docstring

access-token-refresh-tokenclj

(access-token-refresh-token rec__3071__auto__)
(access-token-refresh-token data__3072__auto__ v__3073__auto__)

Lens for the refresh-token field from a [[AccessToken]] record. See active.clojure.openid/make-access-token.

Lens for the `refresh-token` field from a [[AccessToken]] record. See [[active.clojure.openid/make-access-token]].
raw docstring

access-token-tokenclj

(access-token-token rec__3071__auto__)
(access-token-token data__3072__auto__ v__3073__auto__)

Lens for the token field from a [[AccessToken]] record. See active.clojure.openid/make-access-token.

Lens for the `token` field from a [[AccessToken]] record. See [[active.clojure.openid/make-access-token]].
raw docstring

access-token-typeclj

(access-token-type rec__3071__auto__)
(access-token-type data__3072__auto__ v__3073__auto__)

Lens for the type field from a [[AccessToken]] record. See active.clojure.openid/make-access-token.

Lens for the `type` field from a [[AccessToken]] record. See [[active.clojure.openid/make-access-token]].
raw docstring

access-token?clj

(access-token? thing)

Is object a AccessToken record? See active.clojure.openid/make-access-token.

Is object a `AccessToken` record? See [[active.clojure.openid/make-access-token]].
raw docstring

available-login-nameclj

(available-login-name rec__3071__auto__)
(available-login-name data__3072__auto__ v__3073__auto__)

Lens for the name field from a [[AvailableLogin]] record. See active.clojure.openid/make-available-login.

Lens for the `name` field from a [[AvailableLogin]] record. See [[active.clojure.openid/make-available-login]].
raw docstring

available-login-uriclj

(available-login-uri rec__3071__auto__)
(available-login-uri data__3072__auto__ v__3073__auto__)

Lens for the uri field from a [[AvailableLogin]] record. See active.clojure.openid/make-available-login.

Lens for the `uri` field from a [[AvailableLogin]] record. See [[active.clojure.openid/make-available-login]].
raw docstring

available-login?clj

(available-login? thing)

Is object a AvailableLogin record? See active.clojure.openid/make-available-login.

Is object a `AvailableLogin` record? See [[active.clojure.openid/make-available-login]].
raw docstring

ctor16167clj

(ctor16167)

Construct a ErrorCodeInvalidRequest record.

Construct a `ErrorCodeInvalidRequest` record.
raw docstring

ctor16177clj

(ctor16177)

Construct a ErrorCodeInvalidClient record.

Construct a `ErrorCodeInvalidClient` record.
raw docstring

ctor16187clj

(ctor16187)

Construct a ErrorCodeInvalidGrant record.

Construct a `ErrorCodeInvalidGrant` record.
raw docstring

ctor16197clj

(ctor16197)

Construct a ErrorCodeUnauthorizedClient record.

Construct a `ErrorCodeUnauthorizedClient` record.
raw docstring

ctor16207clj

(ctor16207)

Construct a ErrorCodeUnsupportedGrantType record.

Construct a `ErrorCodeUnsupportedGrantType` record.
raw docstring

ctor16217clj

(ctor16217)

Construct a ErrorCodeInvalidScope record.

Construct a `ErrorCodeInvalidScope` record.
raw docstring

default-error-handlerclj

(default-error-handler request
                       {:keys [type description message exception]}
                       original-uri)

default-login-handlerclj

(default-login-handler _req availables unavailables)

default-logout-endpointclj


default-logout-handlerclj

(default-logout-handler _request)

elaboration-error-response-error-codeclj

(elaboration-error-response-error-code rec__3071__auto__)
(elaboration-error-response-error-code data__3072__auto__ v__3073__auto__)

Lens for the error-code field from a [[ElaborationErrorResponse]] record. See active.clojure.openid/make-elaboration-error-response.

Lens for the `error-code` field from a [[ElaborationErrorResponse]] record. See [[active.clojure.openid/make-elaboration-error-response]].
raw docstring

elaboration-error-response-error-descriptionclj

(elaboration-error-response-error-description rec__3071__auto__)
(elaboration-error-response-error-description data__3072__auto__
                                              v__3073__auto__)

Lens for the error-description field from a [[ElaborationErrorResponse]] record. See active.clojure.openid/make-elaboration-error-response.

Lens for the `error-description` field from a [[ElaborationErrorResponse]] record. See [[active.clojure.openid/make-elaboration-error-response]].
raw docstring

elaboration-error-response-error-uriclj

(elaboration-error-response-error-uri rec__3071__auto__)
(elaboration-error-response-error-uri data__3072__auto__ v__3073__auto__)

Lens for the error-uri field from a [[ElaborationErrorResponse]] record. See active.clojure.openid/make-elaboration-error-response.

Lens for the `error-uri` field from a [[ElaborationErrorResponse]] record. See [[active.clojure.openid/make-elaboration-error-response]].
raw docstring

elaboration-error-response?clj

(elaboration-error-response? thing)

Is object a ElaborationErrorResponse record? See active.clojure.openid/make-elaboration-error-response.

Is object a `ElaborationErrorResponse` record? See [[active.clojure.openid/make-elaboration-error-response]].
raw docstring

error-code-invalid-clientclj


error-code-invalid-client?clj

(error-code-invalid-client? thing)

Is object a ErrorCodeInvalidClient record? See active.clojure.openid/ctor16177.

Is object a `ErrorCodeInvalidClient` record? See [[active.clojure.openid/ctor16177]].
raw docstring

error-code-invalid-grantclj


error-code-invalid-grant?clj

(error-code-invalid-grant? thing)

Is object a ErrorCodeInvalidGrant record? See active.clojure.openid/ctor16187.

Is object a `ErrorCodeInvalidGrant` record? See [[active.clojure.openid/ctor16187]].
raw docstring

error-code-invalid-requestclj


error-code-invalid-request?clj

(error-code-invalid-request? thing)

Is object a ErrorCodeInvalidRequest record? See active.clojure.openid/ctor16167.

Is object a `ErrorCodeInvalidRequest` record? See [[active.clojure.openid/ctor16167]].
raw docstring

error-code-invalid-scopeclj


error-code-invalid-scope?clj

(error-code-invalid-scope? thing)

Is object a ErrorCodeInvalidScope record? See active.clojure.openid/ctor16217.

Is object a `ErrorCodeInvalidScope` record? See [[active.clojure.openid/ctor16217]].
raw docstring

error-code-unauthorized-clientclj


error-code-unauthorized-client?clj

(error-code-unauthorized-client? thing)

Is object a ErrorCodeUnauthorizedClient record? See active.clojure.openid/ctor16197.

Is object a `ErrorCodeUnauthorizedClient` record? See [[active.clojure.openid/ctor16197]].
raw docstring

error-code-unsupported-grant-typeclj


error-code-unsupported-grant-type?clj

(error-code-unsupported-grant-type? thing)

Is object a ErrorCodeUnsupportedGrantType record? See active.clojure.openid/ctor16207.

Is object a `ErrorCodeUnsupportedGrantType` record? See [[active.clojure.openid/ctor16207]].
raw docstring

error-code?clj

(error-code? x)

ErrorCodeInvalidClientclj


ErrorCodeInvalidClient-rtd-gensym-16178clj

record-type-descriptor for type ErrorCodeInvalidClient

record-type-descriptor for type ErrorCodeInvalidClient
raw docstring

ErrorCodeInvalidGrantclj


ErrorCodeInvalidGrant-rtd-gensym-16188clj

record-type-descriptor for type ErrorCodeInvalidGrant

record-type-descriptor for type ErrorCodeInvalidGrant
raw docstring

ErrorCodeInvalidRequestclj


ErrorCodeInvalidRequest-rtd-gensym-16168clj

record-type-descriptor for type ErrorCodeInvalidRequest

record-type-descriptor for type ErrorCodeInvalidRequest
raw docstring

ErrorCodeInvalidScopeclj


ErrorCodeInvalidScope-rtd-gensym-16218clj

record-type-descriptor for type ErrorCodeInvalidScope

record-type-descriptor for type ErrorCodeInvalidScope
raw docstring

ErrorCodeUnauthorizedClientclj


ErrorCodeUnauthorizedClient-rtd-gensym-16198clj

record-type-descriptor for type ErrorCodeUnauthorizedClient

record-type-descriptor for type ErrorCodeUnauthorizedClient
raw docstring

ErrorCodeUnsupportedGrantTypeclj


ErrorCodeUnsupportedGrantType-rtd-gensym-16208clj

record-type-descriptor for type ErrorCodeUnsupportedGrantType

record-type-descriptor for type ErrorCodeUnsupportedGrantType
raw docstring

fetch-access-token-for-authorization!clj

(fetch-access-token-for-authorization! openid-profile
                                       authorize-code
                                       &
                                       [redirect-uri])

fetch-access-token-for-graph-api!clj

(fetch-access-token-for-graph-api! openid-profile)

fetch-refreshed-access-token!clj

(fetch-refreshed-access-token! openid-profile refresh-token)

fetch-user-infoclj

(fetch-user-info openid-profile access-token logout-endpoint)

This decodes user-info from the JWT of the access-token. See configuration setting [[openid-config/openid-client-user-info-from]].

This decodes user-info from the JWT of the access-token.
See configuration setting [[openid-config/openid-client-user-info-from]].
raw docstring

fetch-user-info!clj

(fetch-user-info! openid-profile access-token logout-endpoint)

This fetches user info with another request to user-info endpoint. See configuration setting [[openid-config/openid-client-user-info-from]].

This fetches user info with another request to user-info endpoint.
See configuration setting [[openid-config/openid-client-user-info-from]].
raw docstring

format-http-datetimeclj

(format-http-datetime dt)

get-openid-provider-config!clj

(get-openid-provider-config! provider-name
                             provider-config-uri
                             http-client-opts-map)

logins-availablesclj

(logins-availables rec__3071__auto__)
(logins-availables data__3072__auto__ v__3073__auto__)

Lens for the availables field from a [[Logins]] record. See active.clojure.openid/make-logins.

Lens for the `availables` field from a [[Logins]] record. See [[active.clojure.openid/make-logins]].
raw docstring

logins-from-config!clj

(logins-from-config! config & [redirect-uri])

logins-state-profile-mapclj

(logins-state-profile-map rec__3071__auto__)
(logins-state-profile-map data__3072__auto__ v__3073__auto__)

Lens for the state-profile-map field from a [[Logins]] record. See active.clojure.openid/make-logins.

Lens for the `state-profile-map` field from a [[Logins]] record. See [[active.clojure.openid/make-logins]].
raw docstring

logins-unavailablesclj

(logins-unavailables rec__3071__auto__)
(logins-unavailables data__3072__auto__ v__3073__auto__)

Lens for the unavailables field from a [[Logins]] record. See active.clojure.openid/make-logins.

Lens for the `unavailables` field from a [[Logins]] record. See [[active.clojure.openid/make-logins]].
raw docstring

logins?clj

(logins? thing)

Is object a Logins record? See active.clojure.openid/make-logins.

Is object a `Logins` record? See [[active.clojure.openid/make-logins]].
raw docstring

logout-form-hiccupclj

(logout-form-hiccup text user-info)

Render a logout form from given user-info. You need to POST to the IDP's logout endpoint if the user's id-token is too large to be a parameter in a GET request due to too many claims in the token.

Render a logout form from given `user-info`.  You need to POST to the IDP's
logout endpoint if the user's id-token is too large to be a parameter in a GET
request due to too many claims in the token.
raw docstring

logout-hrefclj

(logout-href user-logout-info)

Render a logout link from given user-info. You can use this GET request to the IDP's logout endpoint if the user's id-token is small enough to be a parameter in a GET request when it does not include too many claims.

Render a logout link from given `user-info`.  You can use this GET request to
the IDP's logout endpoint if the user's id-token is small enough to be a
parameter in a GET request when it does not include too many claims.
raw docstring

(logout-link-hiccup text user-info)

make-access-tokenclj

(make-access-token token
                   type
                   refresh-token
                   id-token
                   expires
                   refresh-expires
                   extra-data)
Construct a `AccessToken` record.

`token`: access via [[active.clojure.openid/access-token-token]]
`type`: access via [[active.clojure.openid/access-token-type]]
`refresh-token`: access via [[active.clojure.openid/access-token-refresh-token]]
`id-token`: access via [[active.clojure.openid/access-token-id-token]]
`expires`: access via [[active.clojure.openid/access-token-expires]]
`refresh-expires`: access via [[active.clojure.openid/access-token-refresh-expires]]
`extra-data`: access via [[active.clojure.openid/access-token-extra-data]]
raw docstring

make-available-loginclj

(make-available-login uri name)

Construct a AvailableLogin record.

uri: access via active.clojure.openid/available-login-uri name: access via active.clojure.openid/available-login-name

Construct a `AvailableLogin` record.

`uri`: access via [[active.clojure.openid/available-login-uri]]
`name`: access via [[active.clojure.openid/available-login-name]]
raw docstring

make-elaboration-error-responseclj

(make-elaboration-error-response error-code error-description error-uri)

Construct a ElaborationErrorResponse record.

error-code: access via active.clojure.openid/elaboration-error-response-error-code error-description: access via active.clojure.openid/elaboration-error-response-error-description error-uri: access via active.clojure.openid/elaboration-error-response-error-uri

Construct a `ElaborationErrorResponse` record.

`error-code`: access via [[active.clojure.openid/elaboration-error-response-error-code]]
`error-description`: access via [[active.clojure.openid/elaboration-error-response-error-description]]
`error-uri`: access via [[active.clojure.openid/elaboration-error-response-error-uri]]
raw docstring

make-loginsclj

(make-logins state-profile-map availables unavailables)

Construct a Logins record.

state-profile-map: access via active.clojure.openid/logins-state-profile-map availables: access via active.clojure.openid/logins-availables unavailables: access via active.clojure.openid/logins-unavailables

Construct a `Logins` record.

`state-profile-map`: access via [[active.clojure.openid/logins-state-profile-map]]
`availables`: access via [[active.clojure.openid/logins-availables]]
`unavailables`: access via [[active.clojure.openid/logins-unavailables]]
raw docstring

make-no-access-tokenclj

(make-no-access-token msg & [resp])

make-no-user-infoclj

(make-no-user-info error-message)

Construct a NoUserInfo record.

error-message: access via active.clojure.openid/no-user-info-error-message

Construct a `NoUserInfo` record.

`error-message`: access via [[active.clojure.openid/no-user-info-error-message]]
raw docstring

make-openid-instance-not-availableclj

(make-openid-instance-not-available name tried-endpoint error-msg)
Construct a `OpenidInstanceNotAvailable` record.

`name`: access via [[active.clojure.openid/openid-instance-not-available-name]]
`tried-endpoint`: access via [[active.clojure.openid/openid-instance-not-available-tried-instance]]
`error-msg`: access via [[active.clojure.openid/openid-instance-not-available-error-msg]]
raw docstring

make-openid-profileclj

(make-openid-profile name
                     provider-config
                     client-id
                     client-secret
                     scopes
                     base-uri
                     user-info-from
                     http-client-opts-map)

Construct a OpenidProfile (Wraps all necessary information for a openid identity provider profile.) record.

name: access via active.clojure.openid/openid-profile-name provider-config: access via active.clojure.openid/openid-profile-openid-provider-config client-id: access via active.clojure.openid/openid-profile-client-id client-secret: access via active.clojure.openid/openid-profile-client-secret scopes: access via active.clojure.openid/openid-profile-scopes base-uri: access via active.clojure.openid/openid-profile-base-uri user-info-from: access via active.clojure.openid/openid-profile-user-info-from http-client-opts-map: access via active.clojure.openid/openid-profile-http-client-opts-map

Construct a `OpenidProfile` (Wraps all necessary information for a openid identity provider profile.) record.

`name`: access via [[active.clojure.openid/openid-profile-name]]
`provider-config`: access via [[active.clojure.openid/openid-profile-openid-provider-config]]
`client-id`: access via [[active.clojure.openid/openid-profile-client-id]]
`client-secret`: access via [[active.clojure.openid/openid-profile-client-secret]]
`scopes`: access via [[active.clojure.openid/openid-profile-scopes]]
`base-uri`: access via [[active.clojure.openid/openid-profile-base-uri]]
`user-info-from`: access via [[active.clojure.openid/openid-profile-user-info-from]]
`http-client-opts-map`: access via [[active.clojure.openid/openid-profile-http-client-opts-map]]
raw docstring

make-openid-provider-configclj

(make-openid-provider-config authorize-endpoint
                             token-endpoint
                             userinfo-endpoint
                             end-session-endpoint
                             check-session-endpoint
                             supports-backchannel-logout?)
Construct a `OpenidProviderConfig` record.

`authorize-endpoint`: access via [[active.clojure.openid/openid-provider-config-authorize-endpoint]]
`token-endpoint`: access via [[active.clojure.openid/openid-provider-config-token-endpoint]]
`userinfo-endpoint`: access via [[active.clojure.openid/openid-provider-config-userinfo-endpoint]]
`end-session-endpoint`: access via [[active.clojure.openid/openid-provider-config-end-session-endpoint]]
`check-session-endpoint`: access via [[active.clojure.openid/openid-provider-config-check-session-endpoint]]
`supports-backchannel-logout?`: access via [[active.clojure.openid/openid-provider-config-supports-backchannel-logout?]]
raw docstring

make-unavailable-loginclj

(make-unavailable-login name error)

Construct a UnavailableLogin record.

name: access via active.clojure.openid/unavailable-login-name error: access via active.clojure.openid/unavailable-login-error

Construct a `UnavailableLogin` record.

`name`: access via [[active.clojure.openid/unavailable-login-name]]
`error`: access via [[active.clojure.openid/unavailable-login-error]]
raw docstring

make-user-infoclj

(make-user-info id
                name
                email
                groups
                claims
                openid-profile
                logout-info
                access-token)

Construct a UserInfo record.

id (The user ID the user is known to the IDP. Maybe nil.): access via active.clojure.openid/user-info-id name (The display name of the user, at least firstname and lastname. Maybe nil.): access via active.clojure.openid/user-info-name email (The email address of the user. Maybe nil.): access via active.clojure.openid/user-info-email groups (The groups the user is a member of. Maybe nil.): access via active.clojure.openid/user-info-groups claims (The rest of the claims obtained from the IDP. Maybe nil.): access via active.clojure.openid/user-info-claims openid-profile (The configured profile of the IDP which that this data got obtained.): access via active.clojure.openid/user-info-openid-profile logout-info (The information needed to logout the user, see [[UserLogoutInfo]].): access via active.clojure.openid/user-info-logout-info access-token (The raw access token from the IDP.): access via active.clojure.openid/user-info-access-token

Construct a `UserInfo` record.

`id` (The user ID the user is known to the IDP. Maybe nil.): access via [[active.clojure.openid/user-info-id]]
`name` (The display name of the user, at least firstname and lastname. Maybe nil.): access via [[active.clojure.openid/user-info-name]]
`email` (The email address of the user. Maybe nil.): access via [[active.clojure.openid/user-info-email]]
`groups` (The groups the user is a member of. Maybe nil.): access via [[active.clojure.openid/user-info-groups]]
`claims` (The rest of the claims obtained from the IDP. Maybe nil.): access via [[active.clojure.openid/user-info-claims]]
`openid-profile` (The configured profile of the IDP which that this data got obtained.): access via [[active.clojure.openid/user-info-openid-profile]]
`logout-info` (The information needed to logout the user, see [[UserLogoutInfo]].): access via [[active.clojure.openid/user-info-logout-info]]
`access-token` (The raw access token from the IDP.): access via [[active.clojure.openid/user-info-access-token]]
raw docstring

maybe-user-info-from-requestclj

(maybe-user-info-from-request request)

Retrieve [[UserInfo]] for logged in user from request. Use this function in your handler to obtain information about your user.

Retrieve [[UserInfo]] for logged in user from `request`.
Use this function in your handler to obtain information about your user.
raw docstring

no-access-token-error-messageclj

(no-access-token-error-message rec__3071__auto__)
(no-access-token-error-message data__3072__auto__ v__3073__auto__)

Lens for the error-message field from a [[NoAccessToken]] record. See active.clojure.openid/really-make-no-access-token.

Lens for the `error-message` field from a [[NoAccessToken]] record. See [[active.clojure.openid/really-make-no-access-token]].
raw docstring

no-access-token-error-responseclj

(no-access-token-error-response rec__3071__auto__)
(no-access-token-error-response data__3072__auto__ v__3073__auto__)

Lens for the error-response field from a [[NoAccessToken]] record. See active.clojure.openid/really-make-no-access-token.

Lens for the `error-response` field from a [[NoAccessToken]] record. See [[active.clojure.openid/really-make-no-access-token]].
raw docstring

no-access-token?clj

(no-access-token? thing)

Is object a NoAccessToken record? See active.clojure.openid/really-make-no-access-token.

Is object a `NoAccessToken` record? See [[active.clojure.openid/really-make-no-access-token]].
raw docstring

no-user-info-error-messageclj

(no-user-info-error-message rec__3071__auto__)
(no-user-info-error-message data__3072__auto__ v__3073__auto__)

Lens for the error-message field from a [[NoUserInfo]] record. See active.clojure.openid/make-no-user-info.

Lens for the `error-message` field from a [[NoUserInfo]] record. See [[active.clojure.openid/make-no-user-info]].
raw docstring

no-user-info?clj

(no-user-info? thing)

Is object a NoUserInfo record? See active.clojure.openid/make-no-user-info.

Is object a `NoUserInfo` record? See [[active.clojure.openid/make-no-user-info]].
raw docstring

openid-instance-not-available-error-msgclj

(openid-instance-not-available-error-msg rec__3071__auto__)
(openid-instance-not-available-error-msg data__3072__auto__ v__3073__auto__)

Lens for the error-msg field from a [[OpenidInstanceNotAvailable]] record. See active.clojure.openid/make-openid-instance-not-available.

Lens for the `error-msg` field from a [[OpenidInstanceNotAvailable]] record. See [[active.clojure.openid/make-openid-instance-not-available]].
raw docstring

openid-instance-not-available-nameclj

(openid-instance-not-available-name rec__3071__auto__)
(openid-instance-not-available-name data__3072__auto__ v__3073__auto__)

Lens for the name field from a [[OpenidInstanceNotAvailable]] record. See active.clojure.openid/make-openid-instance-not-available.

Lens for the `name` field from a [[OpenidInstanceNotAvailable]] record. See [[active.clojure.openid/make-openid-instance-not-available]].
raw docstring

openid-instance-not-available-tried-instanceclj

(openid-instance-not-available-tried-instance rec__3071__auto__)
(openid-instance-not-available-tried-instance data__3072__auto__
                                              v__3073__auto__)

Lens for the tried-endpoint field from a [[OpenidInstanceNotAvailable]] record. See active.clojure.openid/make-openid-instance-not-available.

Lens for the `tried-endpoint` field from a [[OpenidInstanceNotAvailable]] record. See [[active.clojure.openid/make-openid-instance-not-available]].
raw docstring

openid-instance-not-available?clj

(openid-instance-not-available? thing)

Is object a OpenidInstanceNotAvailable record? See active.clojure.openid/make-openid-instance-not-available.

Is object a `OpenidInstanceNotAvailable` record? See [[active.clojure.openid/make-openid-instance-not-available]].
raw docstring

openid-profile-base-uriclj

(openid-profile-base-uri rec__3071__auto__)
(openid-profile-base-uri data__3072__auto__ v__3073__auto__)

Lens for the base-uri field from a [[OpenidProfile]] record. See active.clojure.openid/make-openid-profile.

Lens for the `base-uri` field from a [[OpenidProfile]] record. See [[active.clojure.openid/make-openid-profile]].
raw docstring

openid-profile-client-idclj

(openid-profile-client-id rec__3071__auto__)
(openid-profile-client-id data__3072__auto__ v__3073__auto__)

Lens for the client-id field from a [[OpenidProfile]] record. See active.clojure.openid/make-openid-profile.

Lens for the `client-id` field from a [[OpenidProfile]] record. See [[active.clojure.openid/make-openid-profile]].
raw docstring

openid-profile-client-secretclj

(openid-profile-client-secret rec__3071__auto__)
(openid-profile-client-secret data__3072__auto__ v__3073__auto__)

Lens for the client-secret field from a [[OpenidProfile]] record. See active.clojure.openid/make-openid-profile.

Lens for the `client-secret` field from a [[OpenidProfile]] record. See [[active.clojure.openid/make-openid-profile]].
raw docstring

openid-profile-http-client-opts-mapclj

(openid-profile-http-client-opts-map rec__3071__auto__)
(openid-profile-http-client-opts-map data__3072__auto__ v__3073__auto__)

Lens for the http-client-opts-map field from a [[OpenidProfile]] record. See active.clojure.openid/make-openid-profile.

Lens for the `http-client-opts-map` field from a [[OpenidProfile]] record. See [[active.clojure.openid/make-openid-profile]].
raw docstring

openid-profile-nameclj

(openid-profile-name rec__3071__auto__)
(openid-profile-name data__3072__auto__ v__3073__auto__)

Lens for the name field from a [[OpenidProfile]] record. See active.clojure.openid/make-openid-profile.

Lens for the `name` field from a [[OpenidProfile]] record. See [[active.clojure.openid/make-openid-profile]].
raw docstring

openid-profile-openid-provider-configclj

(openid-profile-openid-provider-config rec__3071__auto__)
(openid-profile-openid-provider-config data__3072__auto__ v__3073__auto__)

Lens for the provider-config field from a [[OpenidProfile]] record. See active.clojure.openid/make-openid-profile.

Lens for the `provider-config` field from a [[OpenidProfile]] record. See [[active.clojure.openid/make-openid-profile]].
raw docstring

openid-profile-projection-lensclj

Wraps all necessary information for a openid identity provider profile.

Wraps all necessary information for a openid identity provider profile.
raw docstring

openid-profile-scopesclj

(openid-profile-scopes rec__3071__auto__)
(openid-profile-scopes data__3072__auto__ v__3073__auto__)

Lens for the scopes field from a [[OpenidProfile]] record. See active.clojure.openid/make-openid-profile.

Lens for the `scopes` field from a [[OpenidProfile]] record. See [[active.clojure.openid/make-openid-profile]].
raw docstring

openid-profile-user-info-fromclj

(openid-profile-user-info-from rec__3071__auto__)
(openid-profile-user-info-from data__3072__auto__ v__3073__auto__)

Lens for the user-info-from field from a [[OpenidProfile]] record. See active.clojure.openid/make-openid-profile.

Lens for the `user-info-from` field from a [[OpenidProfile]] record. See [[active.clojure.openid/make-openid-profile]].
raw docstring

openid-profile?clj

(openid-profile? thing)

Is object a OpenidProfile record? See active.clojure.openid/make-openid-profile.

Is object a `OpenidProfile` record? See [[active.clojure.openid/make-openid-profile]].
raw docstring

openid-provider-config-authorize-endpointclj

(openid-provider-config-authorize-endpoint rec__3071__auto__)
(openid-provider-config-authorize-endpoint data__3072__auto__ v__3073__auto__)

Lens for the authorize-endpoint field from a [[OpenidProviderConfig]] record. See active.clojure.openid/make-openid-provider-config.

Lens for the `authorize-endpoint` field from a [[OpenidProviderConfig]] record. See [[active.clojure.openid/make-openid-provider-config]].
raw docstring

openid-provider-config-check-session-endpointclj

(openid-provider-config-check-session-endpoint rec__3071__auto__)
(openid-provider-config-check-session-endpoint data__3072__auto__
                                               v__3073__auto__)

Lens for the check-session-endpoint field from a [[OpenidProviderConfig]] record. See active.clojure.openid/make-openid-provider-config.

Lens for the `check-session-endpoint` field from a [[OpenidProviderConfig]] record. See [[active.clojure.openid/make-openid-provider-config]].
raw docstring

openid-provider-config-end-session-endpointclj

(openid-provider-config-end-session-endpoint rec__3071__auto__)
(openid-provider-config-end-session-endpoint data__3072__auto__ v__3073__auto__)

Lens for the end-session-endpoint field from a [[OpenidProviderConfig]] record. See active.clojure.openid/make-openid-provider-config.

Lens for the `end-session-endpoint` field from a [[OpenidProviderConfig]] record. See [[active.clojure.openid/make-openid-provider-config]].
raw docstring

openid-provider-config-projection-lensclj


openid-provider-config-supports-backchannel-logout?clj

(openid-provider-config-supports-backchannel-logout? rec__3071__auto__)
(openid-provider-config-supports-backchannel-logout? data__3072__auto__
                                                     v__3073__auto__)

Lens for the supports-backchannel-logout? field from a [[OpenidProviderConfig]] record. See active.clojure.openid/make-openid-provider-config.

Lens for the `supports-backchannel-logout?` field from a [[OpenidProviderConfig]] record. See [[active.clojure.openid/make-openid-provider-config]].
raw docstring

openid-provider-config-token-endpointclj

(openid-provider-config-token-endpoint rec__3071__auto__)
(openid-provider-config-token-endpoint data__3072__auto__ v__3073__auto__)

Lens for the token-endpoint field from a [[OpenidProviderConfig]] record. See active.clojure.openid/make-openid-provider-config.

Lens for the `token-endpoint` field from a [[OpenidProviderConfig]] record. See [[active.clojure.openid/make-openid-provider-config]].
raw docstring

openid-provider-config-userinfo-endpointclj

(openid-provider-config-userinfo-endpoint rec__3071__auto__)
(openid-provider-config-userinfo-endpoint data__3072__auto__ v__3073__auto__)

Lens for the userinfo-endpoint field from a [[OpenidProviderConfig]] record. See active.clojure.openid/make-openid-provider-config.

Lens for the `userinfo-endpoint` field from a [[OpenidProviderConfig]] record. See [[active.clojure.openid/make-openid-provider-config]].
raw docstring

openid-provider-config?clj

(openid-provider-config? thing)

Is object a OpenidProviderConfig record? See active.clojure.openid/make-openid-provider-config.

Is object a `OpenidProviderConfig` record? See [[active.clojure.openid/make-openid-provider-config]].
raw docstring

really-make-no-access-tokenclj

(really-make-no-access-token error-message error-response)

Construct a NoAccessToken record.

error-message: access via active.clojure.openid/no-access-token-error-message error-response: access via active.clojure.openid/no-access-token-error-response

Construct a `NoAccessToken` record.

`error-message`: access via [[active.clojure.openid/no-access-token-error-message]]
`error-response`: access via [[active.clojure.openid/no-access-token-error-response]]
raw docstring

really-make-user-logout-infoclj

(really-make-user-logout-info uri params-map)

Construct a UserLogoutInfo (All the informationen needed to render either a logout link or a logout form.) record.

uri: access via active.clojure.openid/user-logout-info-uri params-map: access via active.clojure.openid/user-logout-info-params-map

Construct a `UserLogoutInfo` (All the informationen needed to render either a logout link or a logout form.) record.

`uri`: access via [[active.clojure.openid/user-logout-info-uri]]
`params-map`: access via [[active.clojure.openid/user-logout-info-params-map]]
raw docstring

unavailable-login-errorclj

(unavailable-login-error rec__3071__auto__)
(unavailable-login-error data__3072__auto__ v__3073__auto__)

Lens for the error field from a [[UnavailableLogin]] record. See active.clojure.openid/make-unavailable-login.

Lens for the `error` field from a [[UnavailableLogin]] record. See [[active.clojure.openid/make-unavailable-login]].
raw docstring

unavailable-login-nameclj

(unavailable-login-name rec__3071__auto__)
(unavailable-login-name data__3072__auto__ v__3073__auto__)

Lens for the name field from a [[UnavailableLogin]] record. See active.clojure.openid/make-unavailable-login.

Lens for the `name` field from a [[UnavailableLogin]] record. See [[active.clojure.openid/make-unavailable-login]].
raw docstring

unavailable-login?clj

(unavailable-login? thing)

Is object a UnavailableLogin record? See active.clojure.openid/make-unavailable-login.

Is object a `UnavailableLogin` record? See [[active.clojure.openid/make-unavailable-login]].
raw docstring

user-info-access-tokenclj

(user-info-access-token rec__3071__auto__)
(user-info-access-token data__3072__auto__ v__3073__auto__)

Lens for the access-token field (The raw access token from the IDP.) from a [[UserInfo]] record. See active.clojure.openid/make-user-info.

Lens for the `access-token` field (The raw access token from the IDP.) from a [[UserInfo]] record. See [[active.clojure.openid/make-user-info]].
raw docstring

user-info-claimsclj

(user-info-claims rec__3071__auto__)
(user-info-claims data__3072__auto__ v__3073__auto__)

Lens for the claims field (The rest of the claims obtained from the IDP. Maybe nil.) from a [[UserInfo]] record. See active.clojure.openid/make-user-info.

Lens for the `claims` field (The rest of the claims obtained from the IDP. Maybe nil.) from a [[UserInfo]] record. See [[active.clojure.openid/make-user-info]].
raw docstring

user-info-emailclj

(user-info-email rec__3071__auto__)
(user-info-email data__3072__auto__ v__3073__auto__)

Lens for the email field (The email address of the user. Maybe nil.) from a [[UserInfo]] record. See active.clojure.openid/make-user-info.

Lens for the `email` field (The email address of the user. Maybe nil.) from a [[UserInfo]] record. See [[active.clojure.openid/make-user-info]].
raw docstring

user-info-groupsclj

(user-info-groups rec__3071__auto__)
(user-info-groups data__3072__auto__ v__3073__auto__)

Lens for the groups field (The groups the user is a member of. Maybe nil.) from a [[UserInfo]] record. See active.clojure.openid/make-user-info.

Lens for the `groups` field (The groups the user is a member of. Maybe nil.) from a [[UserInfo]] record. See [[active.clojure.openid/make-user-info]].
raw docstring

user-info-idclj

(user-info-id rec__3071__auto__)
(user-info-id data__3072__auto__ v__3073__auto__)

Lens for the id field (The user ID the user is known to the IDP. Maybe nil.) from a [[UserInfo]] record. See active.clojure.openid/make-user-info.

Lens for the `id` field (The user ID the user is known to the IDP. Maybe nil.) from a [[UserInfo]] record. See [[active.clojure.openid/make-user-info]].
raw docstring

user-info-logout-infoclj

(user-info-logout-info rec__3071__auto__)
(user-info-logout-info data__3072__auto__ v__3073__auto__)

Lens for the logout-info field (The information needed to logout the user, see [[UserLogoutInfo]].) from a [[UserInfo]] record. See active.clojure.openid/make-user-info.

Lens for the `logout-info` field (The information needed to logout the user, see [[UserLogoutInfo]].) from a [[UserInfo]] record. See [[active.clojure.openid/make-user-info]].
raw docstring

user-info-nameclj

(user-info-name rec__3071__auto__)
(user-info-name data__3072__auto__ v__3073__auto__)

Lens for the name field (The display name of the user, at least firstname and lastname. Maybe nil.) from a [[UserInfo]] record. See active.clojure.openid/make-user-info.

Lens for the `name` field (The display name of the user, at least firstname and lastname. Maybe nil.) from a [[UserInfo]] record. See [[active.clojure.openid/make-user-info]].
raw docstring

user-info-openid-profileclj

(user-info-openid-profile rec__3071__auto__)
(user-info-openid-profile data__3072__auto__ v__3073__auto__)

Lens for the openid-profile field (The configured profile of the IDP which that this data got obtained.) from a [[UserInfo]] record. See active.clojure.openid/make-user-info.

Lens for the `openid-profile` field (The configured profile of the IDP which that this data got obtained.) from a [[UserInfo]] record. See [[active.clojure.openid/make-user-info]].
raw docstring

user-info-projection-lensclj


user-info?clj

(user-info? thing)

Is object a UserInfo record? See active.clojure.openid/make-user-info.

Is object a `UserInfo` record? See [[active.clojure.openid/make-user-info]].
raw docstring

user-logout-info-params-mapclj

(user-logout-info-params-map rec__3071__auto__)
(user-logout-info-params-map data__3072__auto__ v__3073__auto__)

Lens for the params-map field from a [[UserLogoutInfo]] record. See active.clojure.openid/really-make-user-logout-info.

Lens for the `params-map` field from a [[UserLogoutInfo]] record. See [[active.clojure.openid/really-make-user-logout-info]].
raw docstring

user-logout-info-projection-lensclj

All the informationen needed to render either a logout link or a logout form.

All the informationen needed to render either a logout link or a logout form.
raw docstring

user-logout-info-uriclj

(user-logout-info-uri rec__3071__auto__)
(user-logout-info-uri data__3072__auto__ v__3073__auto__)

Lens for the uri field from a [[UserLogoutInfo]] record. See active.clojure.openid/really-make-user-logout-info.

Lens for the `uri` field from a [[UserLogoutInfo]] record. See [[active.clojure.openid/really-make-user-logout-info]].
raw docstring

user-logout-info?clj

(user-logout-info? thing)

Is object a UserLogoutInfo record? See active.clojure.openid/really-make-user-logout-info.

Is object a `UserLogoutInfo` record? See [[active.clojure.openid/really-make-user-logout-info]].
raw docstring

wrap-automatic-refreshclj

(wrap-automatic-refresh &
                        {:keys [error-handler]
                         :or {error-handler default-error-handler}})

wrap-openid-authenticationclj

(wrap-openid-authentication config & {:keys [session-store] :as args})

Convenience middleware stack for OpenID authentication that combines all other middlewares that its implementation depends on.

Currently, this is [[ring-session/wrap-session]]. To avoid having more than one instance of the session-store, you have three options:

  • Use optional argument :session-store to pass in your global session store.

  • Bind one instance of this middleware to a variable and use the variable if you need this middleware in different places.

  • Put your own [[ring-session/wrap-session]] in your middleware stack and use wrap-openid-authentication* instead of this middleware.

See wrap-openid-authentication* for OpenID-specific documentation and options.

Convenience middleware stack for OpenID authentication that combines all
other middlewares that its implementation depends on.

Currently, this is [[ring-session/wrap-session]].  To avoid having more than
one instance of the `session-store`, you have three options:

- Use optional argument `:session-store` to pass in your global session store.

- Bind one instance of this middleware to a variable and use the variable if
  you need this middleware in different places.

- Put your own [[ring-session/wrap-session]] in your middleware stack and use
  [[wrap-openid-authentication*]] instead of this middleware.

See [[wrap-openid-authentication*]] for OpenID-specific documentation and
options.
raw docstring

wrap-openid-authentication*clj

(wrap-openid-authentication* config
                             &
                             {:keys [login-handler logout-endpoint error-handler
                                     stubborn-idp-login-endpoint]
                              :or {login-handler default-login-handler
                                   logout-endpoint default-logout-endpoint
                                   error-handler default-error-handler
                                   stubborn-idp-login-endpoint ""}})

Middleware that shortcuts execution of the handler and redirects the user to the login page.

It also takes care of the openid authentication process states unauthenticated, authentication started, authenticated.

The state authentication started is the most complicated one: There, the middleware tries to obtain tokens and user data from the IDP and needs to validate the data.

  • :login-handler: Handler that the middleware calls if currently unauthenticated. The login handler should display links to IDPs to start the authentication process. The login handler gets called with three arguments:

    • request: The current request
    • availables: List of [[Available]] IDPs
    • unavailables: List of [[Unavailable]] IDPs If not :login-handler is given, it defaults to default-login-handler.
  • :logout-endpoint: The endpoint for the IDP to redirect to after user-initated logout. This is needed to remove the auth information from the session. Defaults to default-logout-endpoint. This must match the route that wrap-openid-logout uses.

  • :error-handler: Handler thet the middleware calls in case of some unexpected error. The error handler gets called with these arguments:

    • request: The current request
    • error: A map providing information about the error: | key | description | | -------------| ------------| |:type | REQUIRED. Type of error. One of ::no-profile,::no-auth-code,::no-access-token,::no-user-info,::exception| |:description| REQUIRED. Text description of the error | |:message | OPTIONAL. Additional error message. Supplied for errors of type ::no-access-token,::no-user-info and ::exception | |:elaboration| OPTIONAL. May contain a structured error elaboration object | |:exception | OPTIONAL. Exception that was thrown. Supplied for errors of type ::exception|
    • original-uri: The URI of the original request, useful to try request again Defaults to default-error-handler.
  • :stubborn-idp-login-endpoint: Some IDPs (or their admins) might require a specific login endpoint URI that is different from the recommended base URI. You can set that endpoint here, it gets concatenated onto base URI. Defaults to the empty string.

Middleware that shortcuts execution of the `handler` and redirects the user
to the login page.

It also takes care of the openid authentication process states `unauthenticated`,
`authentication started`, `authenticated`.

The state `authentication started` is the most complicated one: There, the
middleware tries to obtain tokens and user data from the IDP and needs to
validate the data.

- `:login-handler`: Handler that the middleware calls if currently
unauthenticated.  The login handler should display links to IDPs to start the
authentication process.  The login handler gets called with three arguments:
   - `request`: The current request
   - `availables`: List of [[Available]] IDPs
   - `unavailables`: List of [[Unavailable]] IDPs
If not `:login-handler` is given, it defaults to [[default-login-handler]].

- `:logout-endpoint`: The endpoint for the IDP to redirect to after
user-initated logout.  This is needed to remove the auth information from the
session.  Defaults to [[default-logout-endpoint]].  This must match the
route that [[wrap-openid-logout]] uses.

- `:error-handler`: Handler thet the middleware calls in case of some
unexpected error.  The error handler gets called with these arguments:
   - `request`: The current request
   - `error`: A map providing information about the error:
     | key          | description |
     | -------------| ------------|
     |`:type`       | REQUIRED. Type of error. One of `::no-profile`,`::no-auth-code`,`::no-access-token`,`::no-user-info`,`::exception`|
     |`:description`| REQUIRED. Text description of the error |
     |`:message`    | OPTIONAL. Additional error message. Supplied for errors of type `::no-access-token`,`::no-user-info` and `::exception`  |
     |`:elaboration`| OPTIONAL. May contain a structured error elaboration object  |
     |`:exception`  | OPTIONAL. Exception that was thrown. Supplied for errors of type `::exception`|
   - `original-uri`: The URI of the original request, useful to try request
     again
Defaults to [[default-error-handler]].

- `:stubborn-idp-login-endpoint`: Some IDPs (or their admins) might require a
specific login endpoint URI that is different from the recommended base URI.
You can set that endpoint here, it gets concatenated onto base URI.
Defaults to the empty string.
raw docstring

wrap-openid-logoutclj

(wrap-openid-logout &
                    {:keys [logout-handler]
                     :or {logout-handler default-logout-handler}})

Wrapper that removes authentication information from the current session. Use together with wrap-openid-authentication. Must be the handler of the route that wrap-openid-authentication uses as its logout-endpoint.

  • :logout-handler: The handler that this wrapper calls. It gets called with request. Defaults to default-logout-handler which redirects to /.
Wrapper that removes authentication information from the current session.
Use together with [[wrap-openid-authentication]].
Must be the handler of the route that [[wrap-openid-authentication]] uses
as its `logout-endpoint`.

- `:logout-handler`: The handler that this wrapper calls.  It gets called
with `request`.  Defaults to [[default-logout-handler]] which redirects
to `/`.
raw docstring

wrap-openid-sessionclj

(wrap-openid-session & [session-store])

Our implementation uses sessions, so we need [[ring-session/wrap-session]] middleware. This is a convenience wrapper around [[ring-session/wrap-session]] that sets some useful defaults and optionally accepts and uses a given session-store.

Our implementation uses sessions, so we need [[ring-session/wrap-session]] middleware.
This is a convenience wrapper around [[ring-session/wrap-session]] that sets
some useful defaults and optionally accepts and uses a given `session-store`.
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close