Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OKTA-308935: Create Migration Guide for Java Mgmt SDK v2.0.0 #423

Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions MIGRATING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Okta Java Management SDK Migration Guide

This SDK uses semantic versioning and follows Okta's [library version policy](https://developer.okta.com/code/library-versions/). In short, we don't make breaking changes unless the major version changes!

## Migrating from 1.x.x to 2.0.0

Version 2.0.0 of this SDK introduces a number of breaking changes from previous versions.
In addition to many new classes/interfaces, some existing class/interfaces are no longer backward compatible due to method renaming and signature changes, see [Breaking Changes](#breaking-changes).
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved

### Breaking Changes

Following is a list of changes that break backward compatibility in version 2.0.0.

- `com.okta.sdk.client.Client`
- Renamed `createRule` to `createGroupRule`
- Renamed `getRule` to `getGroupRule`
- Renamed `listRules` to `listGroupRules`

- `com.okta.sdk.resource.log.LogEventList`
- `getLogs(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved
Signature changed to `getLogs(java.util.Date, java.util.Date, java.lang.String, java.lang.String, java.lang.String)`

- `com.okta.sdk.resource.group.GroupList`
- `listGroups(java.lang.String,java.lang.String, java.lang.String)`
Signature changed to `listGroups(java.lang.String, java.lang.String)`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved

- `com.okta.sdk.resource.application.JsonWebKey`
- `getExpiresAt` Return type changed from `Date` to `String`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved

- `com.okta.sdk.resource.application.SwaThreeFieldApplicationSettingsApplication`
- `getTargetUrl` Renamed to `getTargetURL`
- `setTargetUrl` Renamed to `setTargetURL`

- `com.okta.sdk.resource.group.Group`
- `getType` Return type changed from `String` to `com.okta.sdk.resource.group.GroupType`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved

- `com.okta.sdk.resource.group.rule.GroupRule`
- Removed `delete`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved
- Removed `getAllGroupsValid`
- Removed `getEmbedded`
- Removed `setAllGroupsValid`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved

- `com.okta.sdk.resource.log.LogAuthenticationContext`
- `getCredentialProvider` Return type changed from `List` to `com.okta.sdk.resource.log.LogCredentialProvider`
- `getCredentialType` Return type changed from `List` to `com.okta.sdk.resource.log.LogCredentialType`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved

- `com.okta.sdk.resource.policy.Policy`
- Removed `createRule`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved

- `com.okta.sdk.resource.policy.PolicyRule`
- Removed `setId`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved

- `com.okta.sdk.resource.user.factor.VerifyFactorRequest`
- Removed `getTokenLifetimeSeconds` & `setTokenLifetimeSeconds`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved

- `com.okta.sdk.resource.user.Role`
- `getType` Return type changed from `String` to `com.okta.sdk.resource.role.RoleType`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved
- `setType` Param type changed from `String` to `com.okta.sdk.resource.role.RoleType`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved

- `com.okta.sdk.resource.user.User`
- Removed `addFactor`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved
- Renamed `addGroupTarget` to `addGroupTargetToRole`
- Renamed `addRole` to `assignRole`
- Removed `endAllSessions`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved
- `expirePassword` Return type changed from `com.okta.sdk.resource.user.TempPassword` to `com.okta.sdk.resource.user.User`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved
- Removed `forgotPassword`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved
- `getFactor` Return type changed from `com.okta.sdk.resource.user.factor.Factor` to `com.okta.sdk.resource.user.factor.UserFactor`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved
- Removed `listAppLinks`
- `listFactors` Return type changed from `com.okta.sdk.resource.user.factor.FactorList` to `com.okta.sdk.resource.user.factor.UserFactorList`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved
- Renamed `listGroupTargetsForRole` to `listGroupTargets`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved
- Removed `listRoles`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved
- `listSupportedFactors` Return type changed from `com.okta.sdk.resource.user.factor.FactorList` to `com.okta.sdk.resource.user.factor.UserFactorList`
- Renamed `removeGroupTargetFromRole` to `removeGroupTarget`
- `resetPassword(java.lang.String, java.lang.Boolean)` Signature changed to `resetPassword(java.lang.Boolean)`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved

- `com.okta.sdk.resource.user.UserCredentials`
- Removed `getEmails` & `setEmails`
arvindkrishnakumar-okta marked this conversation as resolved.
Show resolved Hide resolved