POST /patron/authentication AuthenticatePatron
Authenticate patron
Authenticate patron by credentials.
POST /patron/authentication/authenticate-token AuthenticatePatronByCodeAndCodeVerifier
Authenticate patron by code and code verifier from SSO login.
Request body
application/x-www-form-urlencoded · required - coderequired
- stringThe code obtained from a SSO patron authentication.
- code_verifierrequired
- stringThe code verifier use to create the code challenge use to obtained the code.
- identity_providerrequired
- ConfigurationPatronIdentityProviderType
POST /patron/authentication/identity-provider GetPatronAuthenticationUrlByIdentityProvider
This will fetch a SSO URL used for patron login, matching the chosen identity provider.
Parameters
- identity_providerrequired
- query · ConfigurationPatronIdentityProviderTypeThe identity provider type, found in GET /configuration.
- code_challengerequired
- query · stringA hashed value (of the code_verifier from a PKCE flow) used to secure the authorization code exchange.
- staterequired
- query · stringA random string to protect against CSRF and track the request state. The value should be returned to the Vendor on the callback url after login.
- prompt
- query · string enumIf prompt is set to login, the returned url should force a new login, even if the user is already logged in.
- app_redirect_url
- query · string (uri)This value should be returned to the Vendor on the callback url after login.
Shared across operations: version. See the shared contract on the version page. POST /patron/authentication/no-password AuthenticatePatronNoPassword
Authenticate patron without use of a password
Authenticate patron without use of a password. This should only be used when absolutely necessary.