1# Changelog
2Running changelog of releases since `2.0.0-rc.4`
3
4## v2.18.0
5 - Added `WithHttpInterceptorAndHttpClientPtr` (#371) Thanks @dnelson27
6 - Handle network errors and don't cancel context in request before reading response (#369) Thanks @ttimonen
7
8## v2.17.0
9
10 - Revert integer values representation as integer pointers
11 - Original change was too agreesive for a minor release
12 - All integer fields have a parallel pointer field that can be used as an alternative to deal with 0 values during JSON marshaling
13 - Example `PasswordPolicy` model has fields int64 `Priority` and *int64 `PriorityPtr`
14 - This change will not break code from release v2.15.0 and earlier
15 - New models
16 - `MultifactorEnrollmentPolicy`
17 - `MultifactorEnrollmentPolicyAuthenticatorSettings`
18 - `MultifactorEnrollmentPolicyAuthenticatorStatus`
19 - `MultifactorEnrollmentPolicyAuthenticatorType`
20 - `MultifactorEnrollmentPolicySettings`
21 - `MultifactorEnrollmentPolicySettingsType`
22 - New methods / endpoints
23 - `Application` has `PreviewSAMLAppMetadata` method for `GET /api/v1/apps/{applicationId}/sso/saml/metadata` endpoint.
24 - Added parameters
25 - `Default` bool on `AuthorizationServer` model
26
27## v2.16.0
28
29 - All API integers, which previously had been typed as `int64`, are now typed
30 `*int64` so that serialization of actual `0` values are not ignored when
31 omitempty tags are present for serialization.
32
33## v2.15.0
34
35### Additions
36
37 - Added `POST /api/v1/authenticators` for `CreateAuthenticator` method to `AuthenticatorResource` model by @monde in https://github.com/okta/okta-management-openapi-spec/pull/154
38 - Added `/api/v1/apps/${applicationId}/credentials/secrets` endpoints and `ClientSecret` model by @monde in https://github.com/okta/okta-management-openapi-spec/pull/146
39 - Added property `pkce_required` to the `ApplicationCredentialsOAuthClient` model by @monde in https://github.com/okta/okta-management-openapi-spec/pull/145
40 - Added `uiSchemaId` property to the `ProfileEnrollmentPolicyRuleAction` model by @emanor-okta in https://github.com/okta/okta-management-openapi-spec/pull/144
41
42### Bug fixes
43
44 - Corrected parameters order
45 - `/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules`
46 - `/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}`
47 - By @monde https://github.com/okta/okta-management-openapi-spec/pull/131
48
49## v2.14.0
50
51### Updates
52
53 - Added property `inactivityPeriod` to `VerificationMethod` model [openapi-2.14.0](https://github.com/okta/okta-management-openapi-spec/releases/tag/openapi-2.14.0)
54 - OAuth tokens are cached regardless of what request cache manager is utilized on the client.
55
56## v2.13.0
57
58Okta SDK Golang release in conjunction with [v2.13.0 of the Okta OpenAPI Specification (Management APIs)](https://github.com/okta/okta-management-openapi-spec/releases/tag/openapi-2.13.0)
59
60### Updates
61
62 - Added properties `host`, `integrationKey`, and `secretKey` to `AuthenticatorProviderConfiguration` model to support Duo Authenticator [openapi-2.13.0](https://github.com/okta/okta-management-openapi-spec/releases/tag/openapi-2.13.0)
63 - Renamed query parameter `search` to `filter` on `GET /api/v1/groups` endpoint [openapi-2.13.0](https://github.com/okta/okta-management-openapi-spec/releases/tag/openapi-2.13.0)
64 - New feature, SDK client can authenticate with Bearer token orienting the SDK client to the security scope of a specific application [#310](https://github.com/okta/okta-sdk-golang/pull/310)
65 - Added ability to specify JWT kid header [#308](https://github.com/okta/okta-sdk-golang/pull/308)
66
67### Bug fixes
68
69 - Schema API calls with one of / enum values will have correct type when calling API [#312](https://github.com/okta/okta-sdk-golang/pull/312)
70
71
72## v2.12.1
73 - Corrected out of order method and API parameters
74 - `AuthorizationServerResource`
75 - `ListAuthorizationServerPolicyRules(ctx context.Context, authServerId string, policyId string)`
76 - `CreateAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, body AuthorizationServerPolicyRule)`
77 - Corrected `ListPolicies` generation for new `Policies` interface.
78
79## v2.12.0
80
81### Updates
82 - Update code generation to v2.12.0 of Okta's openapi spec
83 - Update to use trusted origins IFRAME_EMBED - IframeEmbedScopeAllowedApps in Scope
84 - Completed missing code generation of Policy related models
85 - Policy related models implement a `Policies` interface
86 - Correctly handle pass by reference in `CreatePolicy`, `UpdatePolicy`
87
88### Bug fixes
89 - Corrected env var typo on `OKTA_CLIENT_REQUEST_TIMEOUT` in README
90 - Corrected code generation pass by referrence of a Factor instance in `EnrollFactor`, `ActivateFactor`, and `VerifyFactor`
91 - Provider query parameter can be boolean or string
92 - Corrected out of order method and API parameters
93 - `AuthorizationServerResource`
94 - `DeleteAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, ruleId string)`
95 - `GetAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, ruleId string)`
96 - `UpdateAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, ruleId string, body AuthorizationServerPolicyRule)`
97 - `AuthorizationServerPolicyRuleResource`
98 - `UpdateAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, ruleId string, body AuthorizationServerPolicyRule)`
99 - `DeleteAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, ruleId string)`
100
101## v2.11.2
102
103### Updates
104 - Added missing `_links` property to `ResponseLinks` model
105
106## v2.11.1
107
108### Updates
109 - Changes `sendTestEmail` response to a `204 no content` instead of `200 success`
110 - Adds `privateKey` and `teamId` properties to `IdentityProviderCredentialsSigning` to support Apple devices
111 - Adds to `APPLE` to the enums in `FactorProvider' and `LogCredentialProvider
112
113## v2.11.0
114
115### Updates
116
117- New models
118 - `EmailTemplate`
119 - `EmailTemplateContent`
120 - `EmailTemplateCustomization`
121 - `EmailTemplateCustomizationRequest`
122 - `EmailTemplateResource`
123 - `EmailTemplateTestRequest`
124 - `EmailTemplateTouchPointVariant`
125 - `IdpPolicyRuleAction`
126 - `IdpPolicyRuleActionProvider`
127
128## v2.10.1
129
130### Updates
131
132- Policy is first class parent with child policy types.
133
134### Bug fixes
135
136- Special case unmarshal for SocialAuthToken nullable expiresAt being blank from Okta API
137
138## v2.10.0
139
140Release of openapispec 2.10.0
141
142## Supported Endpoints
143* /api/v1/apps/{appId}/connections/default
144* /api/v1/apps/{appId}/connections/default/lifecycle/activate
145* /api/v1/apps/{appId}/connections/default/lifecycle/deactivate
146* /api/v1/apps/{appId}/features
147* /api/v1/apps/{appId}/features/{name}
148* /api/v1/apps/{appId}/logo
149* /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/activate
150* /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate
151* /api/v1/roles/{roleTypeOrRoleId}/subscriptions
152* /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}
153* /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}/subscribe
154* /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}/unsubscribe
155* /api/v1/users/{userId}/subscriptions
156* /api/v1/users/{userId}/subscriptions/{notificationType}
157* /api/v1/users/{userId}/subscriptions/{notificationType}/subscribe
158* /api/v1/users/{userId}/subscriptions/{notificationType}/unsubscribe
159
160## New Methods
161
162## ApplicationResource
163* ActivateDefaultProvisioningConnectionForApplication
164* DeactivateDefaultProvisioningConnectionForApplication
165* GetDefaultProvisioningConnectionForApplication
166* GetFeatureForApplication
167* ListFeaturesForApplication
168* SetDefaultProvisioningConnectionForApplication
169* UpdateFeatureForApplication
170* UploadApplicationLogo
171
172### BrandResource
173* UploadBrandThemeBackgroundImage
174* UploadBrandThemeFavicon
175* UploadBrandThemeLogo
176
177### OrgSettingResource
178* UpdateOrgLogo
179
180### SubscriptionResource
181* GetRoleSubscriptionByNotificationType(ctx context.Context, roleTypeOrRoleId string, notificationType string) (*Subscription, *Response, error) {
182* ListRoleSubscriptions
183* SubscribeRoleSubscriptionByNotificationType
184* SubscribeUserSubscriptionByNotificationType
185* UnsubscribeRoleSubscriptionByNotificationType
186* UnsubscribeUserSubscriptionByNotificationType
187
188### UserResource
189* GetUserSubscriptionByNotificationType
190* ListUserSubscriptions
191
192## New Constructors:
193* NewApplicationFeature
194* NewCapabilitiesCreateObject
195* NewCapabilitiesObject
196* NewCapabilitiesUpdateObject
197* NewLifecycleCreateSettingObject
198* NewLifecycleDeactivateSettingObject
199* NewOrg2OrgApplication
200* NewOrg2OrgApplicationSettings
201* NewOrg2OrgApplicationSettingsApp
202* NewPasswordSettingObject
203* NewProfileSettingObject
204* NewProvisioningConnection
205* NewProvisioningConnectionProfile
206* NewProvisioningConnectionRequest
207
208## New Models and/or Updated models
209* ApplicationFeature
210* CapabilitiesCreateObject
211* CapabilitiesObject
212* CapabilitiesUpdateObject
213* ChangeEnum
214* LifecycleCreateSettingObject
215* LifecycleDeactivateSettingObject
216* NotificationType
217* Org2OrgApplication
218* Org2OrgApplicationSettings
219* Org2OrgApplicationSettingsApp
220* PasswordSettingObject
221* ProfileSettingObject
222* ProvisioningConnection
223* ProvisioningConnectionAuthScheme
224* ProvisioningConnectionProfile
225* ProvisioningConnectionRequest
226* ProvisioningConnectionStatus
227* SeedEnum
228* Subscription
229* SubscriptionStatus
230
231
232## v2.9.2
233
234### Updates
235- Adjustments were made the attributes on the `DeviceAccessPolicyRuleCondition` type.
236- Adding `GroupProfileMap` attribute to `GroupProfile` struct to support additional properties. See #268
237
238
239## v2.9.1
240
241### New Types / Models
242- `AccessPolicy`
243- `AccessPolicyConstraint`
244- `AccessPolicyConstraints`
245- `AccessPolicyRule`
246- `AccessPolicyRuleActions`
247- `AccessPolicyRuleApplicationSignOn`
248- `AccessPolicyRuleConditions`
249- `AccessPolicyRuleCustomCondition`
250- `AuthenticatorProvider`
251- `AuthenticatorProviderConfiguration`
252- `AuthenticatorProviderConfigurationUserNamePlate`
253- `BrandResource`
254- `Brand`
255- `ChannelBinding`
256- `Compliance`
257- `DeviceAccessPolicyRuleCondition`
258- `EmailTemplateTouchPointVariant`
259- `EndUserDashboardTouchPointVariant`
260- `ErrorPageTouchPointVariant`
261- `FipsEnum`
262- `ImageUploadResponse`
263- `KnowledgeConstraint`
264- `PossessionConstraint`
265- `PreRegistrationInlineHook`
266- `ProfileEnrollmentPolicy`
267- `ProfileEnrollmentPolicyRule`
268- `ProfileEnrollmentPolicyRuleAction`
269- `ProfileEnrollmentPolicyRuleActions`
270- `ProfileEnrollmentPolicyRuleActivationRequirement`
271- `ProfileEnrollmentPolicyRuleProfileAttribute`
272- `RequiredEnum`
273- `SignInPageTouchPointVariant`
274- `ThemeResource`
275- `Theme`
276- `ThemeResponse`
277- `UserTypeCondition`
278- `UserVerificationEnum`
279- `VerificationMethod`
280
281### New Methods
282- `AuthenticatorResource`
283 - `GetAuthenticator`
284 - `UpdateAuthenticator`
285 - `ListAuthenticators`
286- `BrandResource`
287 - `GetBrand`
288 - `UpdateBrand`
289 - `ListBrands`
290 - `ListBrandThemes`
291 - `GetBrandTheme`
292 - `UpdateBrandTheme`
293 - `DeleteBrandThemeBackgroundImage`
294 - `UploadBrandThemeBackgroundImage`
295 - `DeleteBrandThemeFavicon`
296 - `UploadBrandThemeFavicon`
297 - `DeleteBrandThemeLogo`
298 - `UploadBrandThemeLogo`
299- `OrgSettingResource`
300 - `UpdateOrgLogo`
301 - `GetOrgPreferences`
302 - `HideOktaUIFooter`
303 - `ShowOktaUIFooter`
304 - `OptInUsersToOktaCommunicationEmails`
305 - `OptOutUsersFromOktaCommunicationEmails`
306 - `GetOrgOktaSupportSettings`
307 - `ExtendOktaSupport`
308 - `GrantOktaSupport`
309 - `RevokeOktaSupport`
310- `ThemeResource`
311 - `GetBrandTheme`
312 - `UpdateBrandTheme`
313
314### Updates
315- Updated Authenticators integration tests
316- Integration tests on `IdentityProviderResource`
317
318## v2.8.0
319
320### Updates
321- methods on client's Authenticator resource for `/api/v1/authenticators` endpoints and their integration tests
322- methods on client's OrgSetting resource for `/api/v1/org` endpoints and their integration tests
323- edge case type fixes in golang code generator
324- `make pull-spec` pulls from https://github.com/okta/okta-management-openapi-spec master or branch set by `OPENAPI_SPEC_BRANCH` env variable
325- golang generator sets api version from spec.json or by env variable override `OKTA_SDK_GOLANG_VERISON`
326- integration test improvements
327
328## v2.6.2
329
330### Updates
331- Okta API Group Schema support #256 thanks @bogdanprodan-okta
332
333### Bug fixes
334- Fix race condition #257 thanks @bogdanprodan-okta, @maxkondr
335
336## v2.6.1
337
338### Bug fixes
339- Pass previous query parameters to the NextPage URL #252 @bogdanprodan-okta
340
341## v2.6.0
342
343### Updates
344- Corrected UserSchemaBase properties field as UserSchemaAttribute #248 @bogdanprodan-okta
345- Added ApplicationSettingsNotes to all apps
346
347## v2.5.2
348
349### Updates
350- Added more fields to the error struct for different error response patterns from API #246 @bogdanprodan-okta
351
352### Bug fixes
353- Fixed error handling for 400/401/403 errors
354
355## v2.5.1
356
357### Updates
358- Hardcode to version 2.5.1 off of main branch of Okta's openapi spec https://github.com/okta/okta-management-openapi-spec
359
360### Bug fixes
361- Fixed code generation inconsistencies from Okta's open API spec #243 @bogdanprodan-okta
362- Fixed/improved app instances interface implementations, removed 'omitemty' tags #241 @bogdanprodan-okta
363- Fixed failed access token requests are not retried. #194 @adw1n
364- Fixed `client.User.CreateUser` example in README. #231 @Sanil2108
365
366## v2.5.0
367
368### Updates
369- Update generated code to version 2.5.0 of Okta's openapi spec https://github.com/okta/okta-management-openapi-spec
370- Refine Makefile's flexibility
371
372## v2.3.1
373
374### Updates
375- Support opaque private keys (#225) @aborrello
376- Improve OAuth 2.0 servapp doc (#221) @juanmatias
377- Removed omitempty from ApplicationGroupAssignment priority field (#218) @bogdanprodan-okta
378- Added `WithHttpClientPtr`, `WithHttpClientPtr` (#214) @bogdanprodan-okta
379- Remove omitempty of 'default_scope' field (#212) @bogdanprodan-okta
380- Add exported OKTA_ACCESS_TOKEN constant (#213) @bretterer
381- Adds Stalebot workflow (#210) @bretterer
382
383### Bug fixes
384- Fixed typo in error message of "too many requests" #230 @halmai
385
386## v2.3.0
387
388### New Structs
389- AuthorizationServerPolicy
390- AuthorizationServerPolicyRule
391
392### Bug fixes
393- Fixed response body parsing
394- Fix error handling for 401 error
395- Retry on EOF errors from HTTP client
396
397### Updates
398- Update `SamlApplicationSettingsSignOn` properties to include `SingleLogout` and `SpCertificate`
399- Update `InlineHookChannelConfig` properties to include `Method`
400- Update `OpenIdConnectApplicationSettingsClient` properties to include `IdpInitiatedLogin`
401
402## v2.2.1
403### Bug Fixes
404- Update default connection Timeout to `60` seconds (#185)
405- Http Client now uses `Timeout` setting for connection timeout (#185)
406- SDK no longer cancels context (#185)
407
408## v2.2.0
409### New Structs
410- `OpenIdConnectApplicationSettingsClientKeys`
411- `OpenIdConnectApplicationSettingsRefreshToken`
412- `OpenIdConnectRefreshTokenRotationType`
413
414### Bug Fixes
415- Updates `okta/OpenIdConnectApplicationSettingsClient` properties to include `jwks []JsonWebKey` (Resolves #176)
416- `NewCustomHotpUserFactor` sets factor type to `token:htop`
417
418### Updates
419- Removes vendor directory
420- Updates `OpenIdConnectApplicationSettingsClient` properties to include `RefreshToken *OpenIdConnectApplicationSettingsRefreshToken`
421
422## v2.1.0
423### New Structs
424- `AcsEndpoint`
425- `CatalogApplication`
426- `CatalogApplicationStatus`
427- `CustomHotpUserFactor`
428- `CustomHotpUserFactorProfile`
429- `InlineHookStatus`
430- `InlineHookType`
431- `WebAuthnUserFactor`
432- `WebAuthnUserFactorProfile`
433
434### Bug Fixes
435- Updates `okta/config.go` to use `github.com/okta/okta-sdk-golang/v2/okta/cache` (#167, Resolves #149)
436- Updates `okta/config.go` to use `int64` for `ConnectionTimeout` and `RequestTimeout` (#166)
437- `ListApplicationTargetsForApplicationAdministratorRoleForGroup` now returns correct `[]CatalogApplication`
438- `ListApplicationTargetsForApplicationAdministratorRoleForUser` now returns correct `[]CatalogApplication`
439- `JsonWebKey.ExpiresAt` changed to correctly use `*time.Time`
440- `verifyUserFactorResponse.ExpiresAt` changed to correctly use `*time.Time`
441- Correctly reads `.okta.yaml` from project root directory
442- Updated typo in `PasswordCredentialHash` struct and changed `WorkerFactor` to the correct `WorkFactor`
443
444### Updates
445- Updates to @okta/openapi 2.1.1 (And associated Generator Updates)
446- Added `UserId` to `OAuth2ScopeConsentGrant` struct
447- **Now Returns error instead of panic from config in `okta.go`** (Resolves #122)
448- `RequestExecutor` returns error if `privPem` is null when using PrivateKey authentication
449- Added `AcsEndpoints` and `AllowMultipleAcsEndpoints` properties to `SamlApplicationSettingsSignOn`
450- Added `FilterType` and `FilterValue` to `SamlAttributeStatement` (Resolves #76)
451- Generated file header in line with Go standard (Resolves #118)
452
453## v2.0.0
454- Official Release of v2 Okta Golang SDK (June 4, 2020)
455- `CSR` Model has been renamed to `Csr`
456- `CSRMetadata` Model has been renamed to `CsrMetadata`
457- `CSRMetadataSubject` Model has been renamed to `CsrMetadataSubject`
458- `CSRMetadataSubjectAltNames` Model has been renamed to `CsrMetadataSubjectAltNames`
459- `GenerateCsrForIdentityProvider` now sets accept header correctly to `application/json`
460
461## v2.0.0-rc.5
462- Remove `PreviewSamlMetadataForApplication` method from `ApplicationResource`
463- `Kid` Query Param removed
464- `KeepCurrent` Query Param removed
465- `ActivateFactorRequest` struct added
466- New Method `GenerateApplicationKey` added to `ApplicationResource`
467- `FactorResultType` struct added
468- `OpenIdConnectApplicationIssuerMode` struct added
469- `InitiateLoginUri` property (type string) added to `OpenIdConnectApplicationSettingsClient` struct
470- `IssuerMode` property (type string) added to `OpenIdConnectApplicationSettingsClient` struct
471- `Format` property (type []string) added to `PolicySubject` struct
472- `ExpiresAt` property (type *time.Time) added to `PushUserFactor` struct
473- `FactorResult` property (type string) added to `PushUserFactor` struct
474- Remove `ClearCurrentUserSession` from `UserResource`
475- `UserFactorResource` method `ActivateFactor` now takes `ActivateFactorRequest` as the `body` param instead of `VerifyFactorRequest`
476- `NextPassCode` property (type string) added to `VerifyFactorRequest` struct
477- Update Readme to show how to access `RequestExecutor` (Fixes #83)
478- Fixes Cache EOF (Fixes #103 and Fixes #36)
479- Update all enum objects to `type string` (Fixes #95)
480- Implement Pagination
481
482## v2.0.0-rc.4
483- Updated Resource Executor to handle nil pointer dereference (#125, fix suggested by @johanbrandhorst)
484- Updates JWT Signer Package issues (#121, fix suggested by @Jmainguy)
View as plain text