okta · sergiishamrai-okta · Dec 2, 2020 · Nov 17, 2020 · Nov 18, 2020 · Nov 18, 2020
@@ -2,6 +2,240 @@
 
 This SDK uses semantic versioning and follows Okta's [library version policy](https://developer.okta.com/code/library-versions/). In short, we do not make breaking changes unless the major version changes!
 
+## Migrating from 2.x.x to 3.0.0
+
+Version 3.0.0 of this SDK introduces a number of breaking changes from previous versions. 
+In addition to many new classes/interfaces, some existing classes/interfaces are no longer backward compatible due to method renaming and signature changes.
+
+[Custom HOTP Factor](https://developer.okta.com/docs/reference/api/factors/#enroll-custom-hotp-factor) is supported now.
+Define a separate Policy model for Authorization Servers.
+Define a separate Policy Rule model for Authorization Servers.
+[SAML Multiple ACS URLs](https://developer.okta.com/docs/reference/api/apps/#acs-endpoint-object) is supported now.
+
+### Package `com.okta.sdk.client.Client`
+
+Below method has been added.
+- `void deleteIdentityProviderKey(String keyId)`
+
+Below methods have undergone a signature change.
+- `listGroups(String q, String filter)` signature changed to `listGroups(String q, String filter, String expand)`
+    - New param `expand` has been added. It's optional and would need to be specified only while using search queries. 
+
+- `listPolicies(String s)` return type changed from `com.okta.sdk.resource.policy.PolicyList` to `com.okta.sdk.resource.authorization.server.AuthorizationServerPolicyList`
+
+### Package `com.okta.sdk.resource.application.AcsEndpoint`
+
+This is a newly created interface with methods listed below.
+- `Integer getIndex()`
+- `AcsEndpoint setIndex(Integer index)`
+- `String getUrl()`
+- `AcsEndpoint setUrl(String url)`
+
+### Package `com.okta.sdk.resource.application.Application` 
+
+Below method has been added.
+- Added `ApplicationGroupAssignment createApplicationGroupAssignment(String groupId)` method.
+    - This method allows assigning a group to an Application.
+
+### Package `com.okta.sdk.resource.application.OpenIdConnectApplicationSettingsClient`
+
+Below methods have been added.
+- `OpenIdConnectApplicationSettingsRefreshToken getRefreshToken()`
+- `OpenIdConnectApplicationSettingsRefreshToken setRefreshToken(OpenIdConnectApplicationSettingsRefreshToken refreshToken)`
+- `OpenIdConnectApplicationSettingsClientKeys getJwks()`
+- `OpenIdConnectApplicationSettingsClient setJwks(OpenIdConnectApplicationSettingsClientKeys jwks)`
+
+### Package `com.okta.sdk.resource.application.OpenIdConnectApplicationSettingsClientKeys`
+
+This is a newly created interface with methods listed below.
+- `JsonWebKeyList getKeys()`
+- `OpenIdConnectApplicationSettingsClientKeys setKeys(JsonWebKeyList keys)`
+
+### Package `com.okta.sdk.resource.application.OpenIdConnectApplicationSettingsRefreshToken`
+
+This is a newly created interface with methods listed below.
+- `Integer getLeeway()`
+- `OpenIdConnectRefreshTokenRotationType getRotationType()`
+- `OpenIdConnectApplicationSettingsRefreshToken setLeeway(Integer leeway)`
+- `OpenIdConnectApplicationSettingsRefreshToken setRotationType(OpenIdConnectRefreshTokenRotationType rotationType)`
+
+With the introduction of enum type `OpenIdConnectRefreshTokenRotationType`, 
+operations `getRotationType()` and `setRotationType(OpenIdConnectRefreshTokenRotationType rotationType)` will use this new enum type.
+
+Enum `OpenIdConnectRefreshTokenRotationType` has 2 fields listed below.
+- `ROTATE("rotate")`
+- `STATIC("static")`
+
+### Package `com.okta.sdk.resource.application.SamlApplicationSettingsSignOn`
+
+Below methods have been added.
+- `List getAcsEndpoints()`
+- `Boolean getAllowMultipleAcsEndpoints()`
+- `SamlApplicationSettingsSignOn setAcsEndpoints(List<AcsEndpoint> acsEndpoints)`
+- `SamlApplicationSettingsSignOn setAllowMultipleAcsEndpoints(Boolean allowMultipleAcsEndpoints)`
+
+### Package `com.okta.sdk.resource.application.SamlApplicationV1`
+
+This is a newly created interface with methods listed below.
+- `SamlApplicationSettings getSettings()`
+- `SamlApplicationV1 setSettings(SamlApplicationSettings settings)`
+
+### Package `com.okta.sdk.resource.application.SamlAttributeStatement` 
+
+Below methods have been added.
+- `String getFilterType()`
+- `String getFilterValue()`
+- `SamlAttributeStatement setFilterType(String filterType)`
+- `SamlAttributeStatement setFilterValue(String filterValue)`
+
+### Package `com.okta.sdk.resource.authorization.server.AuthorizationServer` 
+
+Below methods have undergone a signature change.
+- `createPolicy(com.okta.sdk.resource.policy.Policy policy)` signature changed to `createPolicy(com.okta.sdk.resource.authorization.server.AuthorizationServerPolicy policy)`, return value type changed from `com.okta.sdk.resource.policy.Policy` to `com.okta.sdk.resource.authorization.server.AuthorizationServerPolicy` 
+- `getPolicy(String policyId)` return type changed from `com.okta.sdk.resource.policy.Policy` to `com.okta.sdk.resource.authorization.server.AuthorizationServerPolicy`
+- `listPolicies()` return type changed from `com.okta.sdk.resource.policy.PolicyList` to `com.okta.sdk.resource.authorization.server.AuthorizationServerPolicyList`
+- `updatePolicy(String policyId, com.okta.sdk.resource.policy.Policy policy)` signature changed to `updatePolicy(String policyId, com.okta.sdk.resource.authorization.server.AuthorizationServerPolicy policy)`, return value type changed from `com.okta.sdk.resource.policy.Policy` to `com.okta.sdk.resource.authorization.server.AuthorizationServerPolicy`
+
+### Package `com.okta.sdk.resource.authorization.server.AuthorizationServerPolicy`
+
+This is a newly created interface with methods listed below.
+- `AuthorizationServerPolicyRule createPolicyRule(String authServerId, AuthorizationServerPolicyRule policyRule)`
+- `void deletePolicy(String policyId)`
+- `PolicyRuleConditions getConditions()`
+- `Date getCreated()`
+- `String getDescription()`
+- `Map<String, Object> getEmbedded()`
+- `String getId()`
+- `Date getLastUpdated()`
+- `Map<String, Object> getLinks()`
+- `String getName()`
+- `AuthorizationServerPolicyRule getPolicyRule(String authServerId, String ruleId)`
+- `Integer getPriority()`
+- `StatusEnum getStatus()`
+- `Boolean getSystem()`
+- `PolicyType getType()`
+- `AuthorizationServerPolicyRuleList listPolicyRules(String authServerId)`
+- `AuthorizationServerPolicy setConditions(PolicyRuleConditions conditions)`
+- `AuthorizationServerPolicy setDescription(String description)`
+- `AuthorizationServerPolicy setName(String name)`
+- `AuthorizationServerPolicy setPriority(Integer priority)`
+- `AuthorizationServerPolicy setStatus(StatusEnum status)`
+- `AuthorizationServerPolicy setSystem(Boolean system)`
+- `AuthorizationServerPolicy setType(PolicyType type)`
+- `AuthorizationServerPolicy updatePolicy(String policyId, AuthorizationServerPolicy policy)`
+
+With the introduction of enum type `AuthorizationServerPolicy$StatusEnum`, 
+operations `getStatus()` and `setStatus(StatusEnum status)` will use this new enum type.
+
+Enum `StatusEnum` has 2 fields listed below.
+- `ACTIVE("ACTIVE")`
+- `INACTIVE("INACTIVE")`
+
+### Package `com.okta.sdk.resource.authorization.server.policy.AuthorizationServerPolicyRule`
+
+This is a newly created interface with methods listed below.
+- `void activate()`
+- `void deactivate()`
+- `deletePolicyRule(String authServerId)`
+- `AuthorizationServerPolicyRuleActions getActions()`
+- `AuthorizationServerPolicyRuleConditions getConditions()`
+- `Date getCreated()`
+- `String getId()`
+- `Date getLastUpdated()`
+- `String getName()`
+- `Integer getPriority()`
+- `StatusEnum getStatus()`
+- `Boolean getSystem()`
+- `TypeEnum getType()`
+- `AuthorizationServerPolicyRule setActions(AuthorizationServerPolicyRuleActions actions)`
+- `AuthorizationServerPolicyRule setConditions(AuthorizationServerPolicyRuleConditions conditions)`
+- `AuthorizationServerPolicyRule setName(String name)`
+- `AuthorizationServerPolicyRule setPriority(Integer priority)`
+- `AuthorizationServerPolicyRule setStatus(StatusEnum status)`
+- `AuthorizationServerPolicyRule setSystem(Boolean system)`
+- `AuthorizationServerPolicyRule setType(TypeEnum type)`
+- `AuthorizationServerPolicyRule update(String authServerId)`
+
+With the introduction of enum type `AuthorizationServerPolicyRule$StatusEnum`, operations `getStatus()` and `setStatus(StatusEnum status)` 
+will use this new enum type.
+
+Enum `StatusEnum` has 2 fields listed below.
+- `ACTIVE("ACTIVE")`
+- `INACTIVE("INACTIVE")`
+
+### Package `com.okta.sdk.resource.authorization.server.policy.AuthorizationServerPolicyRuleActions`
+
+This is a newly created interface with methods listed below.
+- `TokenAuthorizationServerPolicyRuleAction getToken()`
+- `AuthorizationServerPolicyRuleActions setToken(TokenAuthorizationServerPolicyRuleAction token)`
+
+### Package `com.okta.sdk.resource.authorization.server.policy.AuthorizationServerPolicyRuleConditions`
+
+This is a newly created interface with methods listed below.
+- `ClientPolicyCondition getClients()`
+- `GrantTypePolicyRuleCondition getGrantTypes()`
+- `PolicyPeopleCondition getPeople()`
+- `OAuth2ScopesMediationPolicyRuleCondition getScopes()`
+- `AuthorizationServerPolicyRuleConditions setClients(ClientPolicyCondition clients)`
+- `AuthorizationServerPolicyRuleConditions setGrantTypes(GrantTypePolicyRuleCondition grantTypes)`
+- `AuthorizationServerPolicyRuleConditions setPeople(PolicyPeopleCondition people)`
+- `AuthorizationServerPolicyRuleConditions setScopes(OAuth2ScopesMediationPolicyRuleCondition scopes)`
+
+### Package `com.okta.sdk.resource.authorization.server.policy.TokenAuthorizationServerPolicyRuleAction`
+
+This is a newly created interface with methods listed below.
+- `Integer getAccessTokenLifetimeMinutes()`
+- `Integer getRefreshTokenLifetimeMinutes()`
+- `Integer getRefreshTokenWindowMinutes()`
+- `TokenAuthorizationServerPolicyRuleAction setAccessTokenLifetimeMinutes(Integer accessTokenLifetimeMinutes)`
+- `TokenAuthorizationServerPolicyRuleAction setRefreshTokenLifetimeMinutes(Integer refreshTokenLifetimeMinutes)`
+- `TokenAuthorizationServerPolicyRuleAction setRefreshTokenWindowMinutes(Integer refreshTokenWindowMinutes)`
+
+### Package `com.okta.sdk.resource.identity.provider.IdentityProvider`
+
+Below method has been removed.
+- `deleteSigningKey(String keyId)`
+
+### Package `com.okta.sdk.resource.policy.PolicyList` 
+
+The Interface has been removed.
+The Interface `com.okta.sdk.resource.authorization.server.AuthorizationServerPolicyList` should be used instead.
+
+### Package `com.okta.sdk.resource.user.factor.CustomHotpUserFactor`
+
+This is a newly created interface with methods listed below.
+- `String getFactorProfileId()`
+- `CustomHotpUserFactorProfile getProfile()`
+- `CustomHotpUserFactor setFactorProfileId(String factorProfileId)`
+- `CustomHotpUserFactor setProfile(CustomHotpUserFactorProfile profile)`
+
+### Package `com.okta.sdk.resource.user.factor.CustomHotpUserFactorProfile`
+
+This is a newly created interface with methods listed below.
+- `String getSharedSecret()`
+- `CustomHotpUserFactorProfile setSharedSecret(String sharedSecret)`
+
+### Package `com.okta.sdk.resource.user.factor.VerifyUserFactorResponse`
+
+Below method has undergone a signature change.
+- `getExpiresAt()` return type changed from `String` to `Date`
+   - The property's `expiresAt` type contains a date-time string, so it's convenient to use the `Date` type
+
+### Package `com.okta.sdk.resource.user.PasswordCredentialHash`
+
+Below methods have been renamed for the sake of clarity.
+- Renamed `getWorkerFactor()` to `getWorkFactor()`
+- Renamed `setWorkerFactor(Integer workFactor)` to `setWorkFactor(Integer workFactor)`
+
+### Package `com.okta.sdk.resource.user.UserBuilder`
+
+Below methods have been added.
+- `UserBuilder setType(UserType userType)`
+- `UserBuilder setType(String userTypeId)`
+- `UserBuilder usePasswordHookForImport()`
+- `UserBuilder usePasswordHookForImport(String type)`
+
+
 ## 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. 

@@ -21,7 +21,7 @@
     <parent>
         <groupId>com.okta.sdk</groupId>
         <artifactId>okta-sdk-root</artifactId>
-        <version>2.0.1-SNAPSHOT</version>
+        <version>3.0.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>okta-sdk-api</artifactId>

@@ -21,7 +21,7 @@
     <parent>
         <groupId>com.okta.sdk</groupId>
         <artifactId>okta-sdk-root</artifactId>
-        <version>2.0.1-SNAPSHOT</version>
+        <version>3.0.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>okta-sdk-coverage</artifactId>

@@ -21,7 +21,7 @@
     <parent>
         <groupId>com.okta.sdk</groupId>
         <artifactId>okta-sdk-root</artifactId>
-        <version>2.0.1-SNAPSHOT</version>
+        <version>3.0.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>okta-sdk-examples</artifactId>

@@ -20,7 +20,7 @@
     <parent>
         <groupId>com.okta.sdk</groupId>
         <artifactId>okta-sdk-examples</artifactId>
-        <version>2.0.1-SNAPSHOT</version>
+        <version>3.0.0-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 

@@ -21,7 +21,7 @@
     <parent>
         <groupId>com.okta.sdk</groupId>
         <artifactId>okta-sdk-root</artifactId>
-        <version>2.0.1-SNAPSHOT</version>
+        <version>3.0.0-SNAPSHOT</version>
         <relativePath>../..</relativePath>
     </parent>
 

@@ -21,7 +21,7 @@
     <parent>
         <groupId>com.okta.sdk</groupId>
         <artifactId>okta-sdk-root</artifactId>
-        <version>2.0.1-SNAPSHOT</version>
+        <version>3.0.0-SNAPSHOT</version>
         <relativePath>../..</relativePath>
     </parent>
 

@@ -21,7 +21,7 @@
     <parent>
         <groupId>com.okta.sdk</groupId>
         <artifactId>okta-sdk-root</artifactId>
-        <version>2.0.1-SNAPSHOT</version>
+        <version>3.0.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>okta-sdk-impl</artifactId>
@@ -121,12 +121,6 @@
             <artifactId>slf4j-simple</artifactId>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>com.okta.sdk</groupId>
-            <artifactId>okta-sdk-api</artifactId>
-            <version>2.0.1-SNAPSHOT</version>
-        </dependency>
-
 
     </dependencies>
 

@@ -20,7 +20,7 @@
     <parent>
         <groupId>com.okta.sdk</groupId>
         <artifactId>okta-sdk-root</artifactId>
-        <version>2.0.1-SNAPSHOT</version>
+        <version>3.0.0-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 

@@ -17,7 +17,6 @@ package com.okta.sdk.tests.it
 
 import com.okta.sdk.client.Client
 import com.okta.sdk.resource.ResourceException
-
 import com.okta.sdk.resource.application.*
 import com.okta.sdk.resource.group.Group
 import com.okta.sdk.resource.group.GroupBuilder
@@ -26,9 +25,8 @@ import com.okta.sdk.tests.it.util.ITSupport
 import org.testng.Assert
 import org.testng.annotations.Test
 
-import static com.okta.sdk.tests.it.util.Util.assertPresent
 import static com.okta.sdk.tests.it.util.Util.assertNotPresent
-
+import static com.okta.sdk.tests.it.util.Util.assertPresent
 import static org.hamcrest.MatcherAssert.assertThat
 import static org.hamcrest.Matchers.*
 
@@ -410,6 +408,10 @@ class ApplicationsIT extends ITSupport {
         assertThat(groupAssignment.priority, equalTo(2))
         assertThat(app.listGroupAssignments().iterator().size(), equalTo(1))
 
+        ApplicationGroupAssignment receivedGroupAssignment = app.getApplicationGroupAssignment(group.getId())
+        assertThat(groupAssignment.getId(), equalTo(receivedGroupAssignment.getId()))
+        assertThat(groupAssignment.getPriority(), equalTo(receivedGroupAssignment.getPriority()))
+
         // delete the assignment
         groupAssignment.delete()
         assertThat(app.listGroupAssignments().iterator().size(), equalTo(0))

@@ -566,7 +566,7 @@ class AuthorizationServerIT extends ITSupport {
         assertThat(createdPolicyRule, notNullValue())
         assertThat(createdPolicyRule.getType(), equalTo(AuthorizationServerPolicyRule.TypeEnum.ACCESS))
 
-        retrievedPolicy.deletePolicyRule(createdAuthorizationServer.getId(), createdPolicyRule.getId())
+        createdPolicyRule.deletePolicyRule(createdAuthorizationServer.getId())
 
         // delete may not effect immediately in the backend
         sleep(getTestOperationDelay())

@@ -99,7 +99,7 @@ class GroupsIT extends ITSupport implements CrudTestSupport {
         validateGroup(group, groupName)
 
         // 2. Search the group by name
-        assertPresent(client.listGroups(groupName, null), group)
+        assertPresent(client.listGroups(groupName, null, null), group)
     }
 
     @Test

@@ -92,6 +92,18 @@ class PolicyRulesIT extends ITSupport implements CrudTestSupport {
         assertThat(policyRule.getStatus(), is(PolicyRule.StatusEnum.INACTIVE))
     }
 
+    @Test
+    void listPolicyRulesTest() {
+        def group = randomGroup()
+        def policy = randomSignOnPolicy(group.getId())
+
+        policy.listPolicyRules().forEach({policyItem ->
+            assertThat(policyItem, notNullValue())
+            assertThat(policyItem.getId(), notNullValue())
+            assertThat(policyItem, instanceOf(Policy.class))
+        })
+    }
+
     @Test
     void createPasswordPolicyRule() {