2.16.0 (2024-12-03)
Added
- Added support for custom prompts #680 (tanya732)
- Added phone number identifier in signup Auth API #679 (tanya732)
- Added is_signup_enabled field to OrganizationConnection #677 (tanya732)
2.15.0 (2024-10-31)
Added
2.14.0 (2024-10-16)
Added
- SDKs support for Control Your Own Key #671 (tanya732)
- Added client credentials changes #670 (tanya732)
- Added support for HRI phase 2 changes #668 (tanya732)
2.13.0 (2024-09-11)
Added
2.12.0 (2024-05-29)
Added
- Support delete all authentication methods endpoint #645 (jimmyjames)
2.11.0 (2024-04-29)
Added
- [SDK-4763] - RIch Authorization Request (RAR) #637 (jimmyjames)
- [SDK-4763] - Add support for HRI Management API changes #635 (jimmyjames)
- [SDK-4763] - add support for JAR and PAR with JAR to Authentication API #636 (jimmyjames)
- [SDK-4769] - add show_as_button to Organization Enabled Connections #631 (jimmyjames)
2.10.1 (2024-01-29)
Deprecated
- Organizations API no longer returns enabled_connections #604 (jimmyjames)
2.10.0 (2023-12-15)
Added
- support backchannel logout property on Client #587 (jimmyjames)
2.9.0 (2023-11-21)
Added
- Support organization in client credentials #582 (jimmyjames)
2.8.0 (2023-11-07)
Fixed
- Propagate error messages on rate limit exceptions #579 (jimmyjames)
2.7.0 (2023-10-31)
Added
- Support organization get member roles #574 (jimmyjames)
- Add passkey properties to authentication method response #575 (jimmyjames)
2.6.1 (2023-09-22)
Security
2.6.0 (2023-09-07)
Security
Fixed
2.5.0 (2023-07-18)
Added
- Support Organization Name on Authorize URL #550 (vasantteja)
Fixed
- Fix deleteAuthenticationMethodById #552 (jimmyjames)
2.4.0 (2023-06-15)
Added
- Support delete authenticator endpoint #541 (vasantteja)
- Support invalidate remembered browsers endpoint #543 (jimmyjames)
Fixed
- Export users does not require connection_id #537 (jimmyjames)
2.3.0 (2023-05-11)
Added
- Support Pushed Authorization Requests #534 (jimmyjames)
2.2.0 (2023-05-02)
Added
- Add support for client credential management #525 (jimmyjames)
Fixed
2.1.0 (2023-03-31)
Added
- Add missing LogEvent fields #521 (jimmyjames)
Changed
- authentication_methods is an object, not a string #520 (jimmyjames)
- Bump jackson dependency to 2.14.2 #522 (jimmyjames)
- Update java-jwt dependency to 4.4.0 #523 (jimmyjames)
2.0.0 (2023-02-23)
2.0.0 introduces several enhances, including:
- HTTP response information returned from requests
- Additional HTTP client configurability
- Ability to configure requests such as add additional parameters and headers
- Support for Authentication API MFA-related APIs
- Authentication API improvements to not require a client secret
- ... and more!
As a major version release, 2.0.0 does include breaking changes. Please see the Migration Guide for additional details as well as guidance for updating your application.
2.0.0 Beta 2 (2023-02-13)
Changed
- Update to latest java-jwt version #512 (jimmyjames)
2.0.0 Beta 1 (2023-01-26)
Added
- Add support for MFA APIs #505 (poovamraj)
- Add support MFA Methods API #506 (poovamraj)
- Support JWT Client Authentication #507 (jimmyjames)
2.0.0 Beta 0 (2023-01-12)
Warning This SDK is in beta and is subject to breaking changes. It is not recommended for production use, but your feedback and help in testing is appreciated!
This release introduces several enhancement, including:
- HTTP response information returned from requests
- Additional HTTP client configurability
- Authentication API improvements to not require a client secret
- ... and more!
Please see the Migration Guide for guidance on updating your application.
1.44.2 (2023-01-11)
This patch release does not contain any functional changes, but is being released using an updated signing key for verification as part of our commitment to best security practices. Please review the README note for additional details.
Security
- Bump java-jwt dependency to 3.19.4 #498 (jimmyjames)
1.44.1 (2022-10-25)
Security
- Bump
java-jwt
to 3.19.3 #465 (jimmyjames) - Bump
com.fasterxml.jackson.core:jackson-databind
to 2.13.4.2 #464 (evansims)
1.44.0 (2022-10-20)
Added
- Integrate ship orb #458 (jimmyjames)
- [SDK-2558] Add support for tenant session cookie #457 (jimmyjames)
- Support stage property on Breached Password Detection #456 (ewanharris)
Changed
- Update to Gradle 6.9.2 #455 (jimmyjames)
1.43.0 (2022-09-19)
Added
- Add support for deleting all user's authenticators #451 (jimmyjames)
- Add session idle lifetime and make session lifetime doubles #423 (pelletier197)
- #448 Adding field filter option to get client by ID API #449 (bhatmadhavi)
- Add missing fields in Client model #444 (poovamraj)
- Add Ship CLI configuration #433 (frederikprijck)
Changed
- Update to OSS plugin version 0.17.2 #450 (jimmyjames)
- Bump oss-library and auth0/ship #441 (frederikprijck)
- Ensure version is defined before plugins are applied #439 (frederikprijck)
Security
- Replace Codecov uploader w/ CircleCI Orb #446 (evansims)
- Security: Update OkHttp to 4.10.0 #438 (evansims)
1.42.0 (2022-05-20)
Added
- Added support for Key management API #431 (poovamraj)
- Support for custom scheme URL #429 (poovamraj)
- Add enabled connections on organization #426 (charliearaya)
1.41.0 (2022-04-19)
Fixed
- Do not cast error values to String #421 (jimmyjames)
- Fix double-encoding of log event filter query param #420 (jimmyjames)
1.40.2 (2022-04-07)
Security
- Update OkHttp to address CVE-2021-0341 #417 (lbalmaceda)
1.40.1 (2022-03-30)
Security
- Bump java-jwt to 3.19.1 #415 (poovamraj)
- Security: Bump
jackson-databind
to 2.13.2.2 #414 (evansims)
1.40.0 (2022-03-14)
Changed
- Update java-jwt dependency #413 (jimmyjames)
Security
1.39.0 (2022-02-18)
Added
- [SDK-3116] Add support for Attack Protection APIs #405 (jimmyjames)
- Feature/add branding #399 (pelletier197)
Changed
- Feature/reduce duplication #381 (pelletier197)
1.38.0 (2022-02-01)
Added
- Support maxRequests and maxRequestsPerHost client confiugrations #402 (jimmyjames)
1.37.0 (2022-01-20)
Added
- Add support for Connection realms #397 (jimmyjames)
- Improve logging #392 (jimmyjames)
Deprecated
- Deprecate setLoggingEnabled on API clients #396 (jimmyjames)
1.36.1 (2022-01-14)
Security
1.36.0 (2022-01-10)
Fixed
- [SDK-2975] Fix withOrganization method visibility on token verifier #388 (jimmyjames)
- remove warning for untyped requests #385 (pelletier197)
1.35.0 (2021-10-20)
Added
- Added get job error details method to JobEntity #383 (jasonfagerberg-toast)
- Add MFA Authentication policies to GuardianEntity #379 (pelletier197)
Fixed
- Fix de/serialization of Invitation roles #380 (lbalmaceda)
1.34.1 (2021-09-21)
Fixed
- Add user_name field to LogEvent #375 (jimmyjames)
1.34.0 (2021-08-27)
Added
- Include log_id in the LogEvent entity #372 (jimmyjames)
- [SDK-2716] Add support for Actions Management APIs #369 (jimmyjames)
- [SDK-2686] Add retry on rate limit errors for management API #368 (jimmyjames)
Fixed
- Fix to rollback action version endpoint #370 (jimmyjames)
1.33.0 (2021-07-26)
Added
- [SDK-2664] Add support for checkpoint pagination #362 (jimmyjames)
Deprecated
- Deprecate unused constructors in Page implementations #363 (jimmyjames)
1.32.0 (2021-07-05)
Added
- [SDK-2622] Add expiresAt to token response #357 (jimmyjames)
Changed
- Update OSS release plugin version #358 (lbalmaceda)
1.31.0 (2021-05-10)
Added
- [SDK-2550] Add networking client timeout configuration #354 (jimmyjames)
1.30.0 (2021-04-28)
Added
- [SDK-2537] Add missing parameters to Ticket entities #352 (jimmyjames)
1.29.0 (2021-04-09)
Added
- Adds method to get an organization's enabled connection and update JavaDocs #344 (jimmyjames)
- Add Organizations Management API Support [SDK-2437] #341 (jimmyjames)
1.28.1 (2021-04-05)
Fixed
- Fix
NoSuchMethodError
when projects have OkHttp 3 dependency #342 (jimmyjames)
1.28.0 (2021-03-25)
Added
- Add support for organizations feature #338 (jimmyjames)
Changed
- Update Gradle OSS Plugin #339 (jimmyjames)
1.27.0 (2021-02-05)
Added
- Add support for async requests #328 (jimmyjames)
Changed
- Update dependency versions #329 (jimmyjames)
1.26.0 (2020-12-02)
Added
- Add refresh token configuration object to client #321 (JakeUskoski)
Fixed
- Fix OkHttp dependency version #325 (jimmyjames)
- Tidy up code #317 (jsalinaspolo)
1.25.0 (2020-11-16)
Changed
- Update to OkHttp 4 #319 (jimmyjames)
- Use java8 #316 (jsalinaspolo)
1.24.0 (2020-11-02)
Added
- Add methods to determine cause of APIException #310 (jimmyjames)
Breaking Changes
- Return TokenRequest instead of AuthRequest #309 (jimmyjames)
Note: We aim to not introduce breaking changes within a release stream. We have taken steps, including running API compatibility checks, to prevent introducing breaking changes in the future.
Fixed
- Add unchecked warnings failures for src #311 (jimmyjames)
1.23.0 (2020-10-22)
Added
- Add support for MFA OTP exchange #303 (jimmyjames)
- Passwordless support #300 (jimmyjames)
- Add scope to TokenHolder #297 (jimmyjames)
- Add inicludeEmailInRedirect field for create email verification ticket endpoint #296 (jimmyjames)
Changed
- Update dependencies #299 (jimmyjames)
1.22.1 (2020-10-13)
Fixed
- Use Standard Jackson Date serialization #295 (jimmyjames)
1.22.0 (2020-09-28)
Added
- Add support for identity field for email verification jobs and tickets #293 (jimmyjames)
1.21.0 (2020-08-27)
Added
- Add support for Log Streams #284 (jimmyjames)
1.20.0 (2020-07-27)
Added
Fixed
- Fix and document thread-safety #272 (lbalmaceda)
1.19.0 (2020-06-05)
Added
- Add display_name property to Connection #267 (lbalmaceda)
- Add support for java Proxy with basic auth #266 (lbalmaceda)
1.18.0 (2020-05-29)
Added
- Add ID Token verifier API #260 (jimmyjames)
- Add signature verification classes #258 (jimmyjames)
Changed
- Update to OkHttp 3.14.9 #262 (jimmyjames)
1.17.0 (2020-05-22)
Added
- Add missing property last_password_reset #256 (mario-moura-silva)
- Add missing "sources" property to the Permission #254 (lbalmaceda)
1.16.0 (2020-04-24)
Added
- Add Job "POST User Imports" endpoint #249 (lbalmaceda)
- Add a new class to handle Multipart requests #248 (lbalmaceda)
- Add Job "GET Status" endpoint #247 (lbalmaceda)
- Add missing "initiate_login_uri" property to Client #244 (lbalmaceda)
- Use char array for passwords #242 (jimmyjames)
- Add Job "POST User Exports" endpoint #241 (lbalmaceda)
- Add Rules Configs entity #240 (lbalmaceda)
Deprecated
- deprecated string password APIs #243 (jimmyjames)
Fixed
- Make CreatedUser take the id from different properties #245 (lbalmaceda)
Security
- Use char array for passwords #242 (jimmyjames)
1.15.0 (2019-11-12)
Changed
- Allow to set the client is_first_party property #230 (lbalmaceda)
1.14.3 (2019-09-25)
Security
- Update jackson-databind to address CVE #225 (jimmyjames)
1.14.2 (2019-08-15)
Fixed
- Find the right JDK version for Telemetry #220 (lbalmaceda)
Security
- Update dependencies #222 (jimmyjames)
1.14.1 (2019-07-03)
Security
- Update jackson-databind dependency to fix security vulnerability #217 (jimmyjames)
1.14.0 (2019-07-02)
Added
- Add getter for DeviceCredentials client_id #215 (lbalmaceda)
- Add missing ResourceServer properties #214 (lbalmaceda)
1.13.3 (2019-05-22)
Fixed
- Add missing metadata field to Connection object #206 (AlisonT1230)
Security
- Bump dependencies and solve security issues #209 (lbalmaceda)
1.13.2 (2019-05-01)
Fixed
- Dynamically obtain the project version for telemetry #201 (lbalmaceda)
1.13.1 (2019-04-25)
Fixed
1.13.0 (2019-04-23)
Added
1.12.0 (2019-04-17)
Added
- Update Telemetry format and allow to customize it #195 (lbalmaceda)
Changed
- Remove default version for search_engine #194 (lbalmaceda)
1.11.0 (2019-03-14)
Added
1.10.0 (2019-01-03)
Added
Fixed
Security
1.9.1 (2018-10-23)
Security
- Use jackson-databind 2.9.7 #168 (lbalmaceda)
1.9.0 (2018-09-25)
Added
- Allow to retrieve Rate Limit headers #153 (rvillablanca)
- Add web_origins attribute to the Client class #148 (lbalmaceda)
- Application (aka Client) description field support #147 (rrybalkin)
1.8.0 (2018-07-13)
Added
- Allow to update the Management API token #141 (lbalmaceda)
- Allow to set search_engine version for Users API #140 (lbalmaceda)
- Make Connections accept include_totals parameter #135 (lbalmaceda)
- Add pagination support to Client Grants, Grants, Resource Servers and Rules #132 (lbalmaceda)
Deprecated
- Deprecate old list methods that do not support pagination #136 (lbalmaceda)
1.7.0 (2018-06-11)
Added
- Support pagination on the Clients entity #124 (lbalmaceda)
- Add Resend verification email functionality #120 (minhlongdo)
Deprecated
- Deprecate ClientsEntity#list() method #128 (lbalmaceda)
Security
- Security fix and dependencies update #129 (lbalmaceda)
1.6.0 (2018-06-04)
Added
- Expose additional error response properties in the Exception #123 (lbalmaceda)
- Add email-templates endpoints #117 (lbalmaceda)
1.5.1 (2018-03-01)
Fixed
- Support password policy error response #108 (lbalmaceda)
- Close ResponseBody buffer after read #101 (lbalmaceda)
1.5.0 (2017-12-07)
Added
1.4.0 (2017-11-30)
Added
- Add user_id setter #93 (lbalmaceda)
- Add /v2/users-by-email endpoint #87 (lbalmaceda)
Breaking changes
- Include a proper SignUp response #92 (lbalmaceda)
1.3.1 (2017-11-01)
Full Changelog Closed issues
- NullPointerException, StdDeserializer #78
Fixed
1.3.0 (2017-09-08)
Added
Changed
1.2.0 (2017-08-07)
Full Changelog Closed issues
- Get AD connection's provisioning_ticket_url property #66
Added
- Add support for provisioning_ticket_url property to Connection POJO #67 (unnamed38)
- Add public User constructor without parameters #59 (lbalmaceda)
Removed
- Remove invalid Logout URL parameter #65 (lbalmaceda)
1.1.0 (2017-05-23)
Added
- Add getter for User and ProfileData extra properties #56 (lbalmaceda)
- Add renew authentication endpoint #51 (lbalmaceda)
- Add revoke token endpoint #50 (lbalmaceda)
- Add getter for Identity extra properties #45 (lbalmaceda)
- Add response_type and custom parameter setter for AuthorizeUrlBuilder #40 (lbalmaceda)
Changed
Fixed
- Fix "q" query parameter encoding #55 (lbalmaceda)
- Close the ResponseBody after its parsed #38 (lbalmaceda)
1.0.0 (2017-01-30)
Reworked Auth0 SDK for java by providing better support for non-Android application (for Android please use Auth0.Android).
The changes from v0 includes:
- OAuth 2.0 endpoints in Authentication API
- Sync calls by default
- Added Management API endpoints
- Better error handling for Auth and Management API erros
The implementation is based on the Authentication API Docs.
Create a new AuthAPI
instance by providing the client data from the dashboard.
AuthAPI auth = new AuthAPI("{YOUR_DOMAIN}", "{YOUR_CLIENT_ID}", "{YOUR_CLIENT_SECRET}");
The implementation is based on the Management API Docs.
Create a new ManagementAPI
instance by providing the domain from the client dashboard and the API Token. Click here for more information on how to obtain a valid API Token.
ManagementAPI mgmt = new ManagementAPI("{YOUR_DOMAIN}", "{YOUR_API_TOKEN}");
The Management API is divided into different entities. Each of them have the list, create, update, delete and update methods plus a few more if corresponds. The calls are authenticated using the API Token given in the ManagementAPI
instance creation and must contain the scope
required by each entity. See the javadoc for details on which scope
is expected for each call.
- Client Grants: See Docs. Access the methods by calling
mgmt.clientGrants()
. - Clients: See Docs. Access the methods by calling
mgmt.clients()
. - Connections: See Docs. Access the methods by calling
mgmt.connections()
. - Device Credentials: See Docs. Access the methods by calling
mgmt.deviceCredentials()
. - Logs: See Docs. Access the methods by calling
mgmt.logEvents()
. - Rules: See Docs. Access the methods by calling
mgmt.rules()
. - User Blocks: See Docs. Access the methods by calling
mgmt.userBlocks()
. - Users: See Docs. Access the methods by calling
mgmt.users()
. - Blacklists: See Docs. Access the methods by calling
mgmt.blacklists()
. - Emails: See Docs. Access the methods by calling
mgmt.emailProvider()
. - Guardian: See Docs. Access the methods by calling
mgmt.guardian()
. - Stats: See Docs. Access the methods by calling
mgmt.stats()
. - Tenants: See Docs. Access the methods by calling
mgmt.tenants()
. - Tickets: See Docs. Access the methods by calling
mgmt.tickets()
.