Skip to content

CHANGELOG.md

Latest commit

 

History

History
563 lines (396 loc) · 39.9 KB

CHANGELOG.md

File metadata and controls

563 lines (396 loc) · 39.9 KB

0.51.0 (Unreleased)

  • Support for Connected Organizations (#156)
  • Bugfix: Add nil slice check in AccessPackageResourceClient.Get() (#187)
  • Bugfix: AccessPackageResource.Description has changed from a *bool to a *string (#187)

0.50.0 (October 14, 2022)

  • Environments: add Synapse API in USGovernment (#186)

0.49.0 (September 29, 2022)

  • Service Principals: support for the Oauth2PermissionScopes field (json oauth2PermissionScopes), which is used by the v1.0 API (#183)

0.48.0 (September 29, 2022)

  • Bug fix: SynchronizationTaskExecution.CountEntitled has changed from a string to an int64 (#172)
  • Support for B2C User Flows (#179)
  • Support for User Flow Attributes (#182)
  • Add an AdditionalData field of type map[string]interface{} to the DirectoryObject model, for returning additional untyped fields (#171)
  • AppRoleAssignmentsClient.List() - support odata query parameters (#181)
  • Environments: add new well-known App IDs MicrosoftAzureFrontDoor and MicrosoftAzureFrontDoorCdn` (#175)
  • OData: Support for a ConsistencyLevel header with the value session (#174)

⚠️ BREAKING CHANGES:

  • Group.GroupTypes has changed from a []GroupType to a *[]GroupType (#160)
  • Group.ResourceBehaviorOptions has changed from a []GroupResourceBehaviorOption to a *[]GroupResourceBehaviorOption (#160)
  • Group.ResourceProvisioningOptions has changed from a []GroupResourceProvisioningOption to a *[]GroupResourceProvisioningOption (#160)

0.47.1 (August 30, 2022)

  • Bugfix: Add missing configuration checks for OIDC methods in the auth.Config.NewAuthorizer() method (#173)

0.47.0 (August 25, 2022)

0.46.0 (April 27, 2022)

  • Added Azure Security Insights to environments.PublishedApis (#162)
  • Added linux to supported msgraph.ConditionalAccessDevicePlatform values (#163)
  • Added SubscribeMembersToCalendarEventsDisabled to supported msgraph.GroupResourceBehaviorOption values (#163)

0.45.0 (April 21, 2022)

⚠️ BREAKING CHANGES:

  • Removed omitempty from the JSON struct tag for the Locations and Platforms fields of the msgraph.ConditionalAccessConditionSet model (#161)

0.44.0 (April 19, 2022)

0.43.0 (March 15, 2022)

⚠️ BREAKING CHANGES:

  • This release removes the following, which have been replaced by compatible equivalents in the new hamilton-autorest module (#154)
    • auth.AutorestAuthorizerWrapper{} struct
    • auth.CachedAuthorizer{}.BearerAuthorizerCallback() method
    • auth.CachedAuthorizer{}.WithAuthorization() method
    • auth.NewAutorestAuthorizerWrapper() function
    • auth.ServicePrincipalToken interface
    • environments.EnvironmentFromMetadata() function

0.42.0 (March 9, 2022)

0.41.1 (February 3, 2022)

⚠️ BREAKING CHANGES:

  • Bug fix: UnifiedRoleDefinition.Description has changed from a *string to a *StringNullWhenEmpty (#148)
  • Bug fix: UnifiedRolePermission.Condition has changed from a *string to a *StringNullWhenEmpty (#148)

0.41.0 (February 3, 2022)

  • Support for selecting GitHub OIDC authentication when using the auth.NewAuthorizer() helper function (#145)
  • Bump supported Go version to 1.17.6 (#145)

0.40.1 (January 28, 2022)

  • Bug fix: Correct the type for AllowExternalSenders field in the Group model (#143)
  • GroupsClient{}.Update() - Don't include the ID in the body when updating a group, as this prevents some Unified group fields from being updated (#143)

0.40.0 (January 26, 2022)

  • Add a new authorizer GitHubOIDCAuthorizer which supports OIDC token exchange for authenticating to Azure Active Directory (#142)
  • Support v1.0 API for Entitlement Management (#133)
    • AccessPackageQuestion model - add the Choices and IsSingleLineQuestion fields
    • AccessPackageCatalog model - add the State field
    • AssignmentReviewSettings model - add the IsAccessRecommendationEnabled, IsApprovalJustificationRequired and AccessReviewTimeoutBehavior fields
    • UserSet model - add the ManagerLevel field
    • New model: AccessPackageMultipleChoiceQuestions
  • Support for Role Definitions via the unified role management endpoint (#137)
  • Support for Role Assignments via the unified role management endpoint (#137)

⚠️ BREAKING CHANGES:

  • AccessPackage model - the CatalogId field is replaced by the Catalog field
  • AssignmentReviewSettings model - the RecurrenceType field now has a custom type
  • AssignmentReviewSettings model - the ReviewerType field now has a custom type

0.39.0 (January 7, 2022)

  • Support for Federated Identity Credentials (beta-only) (#134)
  • Bug fix: corrected the DisplayName struct tag for the GroupAssignedLabel model (#135)
  • Bug fix: fixed a typo in the constant AccessPackageResourceRequestTypeAdminRemove (was AccessPackageResourceRequestTypeAdmminRemove) (#135)

0.38.0 (December 8, 2021)

⚠️ BREAKING CHANGES:

  • Bug fix: Group.MembershipRule has changed from a *string to a *StringNullWhenEmpty (#132)

0.37.0 (November 29, 2021)

  • Add some missing API endpoints for national cloud environments (#129)
  • Add an Api{}.IsAvailable() method to determine whether a service is supported for an environment (#129)
  • Fix an incorrect hostname for environments.KeyVaultUSGovEndpoint (#128)
  • Support for autorest.BearerAuthorizerCallback in auth.CachedAuthorizer (#130)

0.36.1 (November 25, 2021)

  • Fix an incorrect enum value for ConditionalAccessDevicePlatformAll (#127)

0.36.0 (November 25, 2021)

0.35.0 (November 16, 2021)

  • Auth package refactoring (#123)

    • Remove the auth.Api type and instead use environments.Api directly
    • Use the resource URI instead of the friendly name for Azure CLI auth tokens

  • Add the AuxiliaryTokens() method to the auth.Authorizer interface to support obtaining tokens for additional tenants (#123)

  • Expand support in auth.AutorestAuthorizerWrapper to support any autorest.Authorizer (#123)

    • autorest.BearerAuthorizer and autorest.MultiTenantBearerAuthorizer are fully supported with access tokens, refresh tokens and expiry
    • Other authorizers can supply access tokens only

  • Support auxiliary tenants with client secret and client certificate authorizers (#123)

  • Implement the autorest.Authorizer interface with auth.CachedAuthorizer (which wraps all supported Authorizers) (#123)

  • Export environment configs for more management plane APIs (#123)

    • Resource Manager
    • Batch Management
    • Data Lake
    • Gallery
    • KeyVault
    • Operational Insights
    • OSS RDBMS
    • Service Bus
    • Service Management (Azure Classic)
    • SQL Database
    • Storage
    • Synapse

  • Refactor and tidy up tests for the msgraph package (#123)

  • Say goodbye to Azure Germany 🇩🇪 (#123)

⚠️ BREAKING CHANGES:

  • The signatures for auth.NewClientCertificateAuthorizer, auth.NewClientSecretAuthorizer and auth.NewAzureCliAuthorizer have changed to accommodate passing additional tenant IDs for multi-tenant authorization (#123)

0.34.0 (November 12, 2021)

  • Remove a surplus configuration check when using Managed Identity authentication, which improves compatibility with Azure Cloud Shell (#119)
  • Add a new authorizer AutorestAuthorizerWrapper which supports obtaining tokens from go-autorest via autorest.BearerAuthorizer (#120)

0.33.0 (October 14, 2021)

  • Support for specifying the client ID when using managed identity authentication (#115)
  • Mitigation for breaking API changes around the @odata.id field (#114)
    • If @odata.id is returned in the form objectType('GUID') (i.e. not a valid URI), then attempt to reconstruct a URI
    • This currently hardcodes the graph.microsoft.com host in the generated URI but this does not appear to be a problem for other clouds
    • This field is exported in all structs that reference it, so it's possible to override this if necessary
  • Support for running msgraph tests in national clouds (#114)

⚠️ BREAKING CHANGES:

  • The signatures for the auth.NewMsiAuthorizer() and auth.NewMsiConfig() functions have changed to accommodate the client ID (#115)

0.32.0 (October 6, 2021)

  • Support for setting OData-related HTTP headers
    • Implement a new way to pass the entire odata.Query object as part of request inputs
    • Update all existing clients to pass odata.Query in full
      • The existing method of passing a url.Valuesmap still works, maintains compatibility and can be used for passing non-odata related query parameters
    • Support setting OData-related HTTP headers including OData-Version / OData-MaxVersion, odata-json parameters on the Accept header, and the ConsistencyLevel header which isn't strictly in the odata 'standard' but heavily related
    • Set the odata.metadata parameter to full when retrieving directory objects to ensure the @odata.id field is returned
      • This dramatically increases the payload volume so we don't default it everywhere
  • Support for assigning and retrieving a user's manager (#111)
  • Add application ID for "Azure VPN" to environments package (#113)

0.31.1 (September 30, 2021)

  • Bug fix: User{}.EmployeeType is a nullable string (#110)

0.31.0 (September 30, 2021)

  • Add support for Entitlement Management (beta-only API) (#93)
  • Bug fix: handle inconsistent 400 error when listing sign-in reports with an OData filter (#108)
  • Bug fix: work around an API consistency issue when creating service principals for new applications that have not fully replicated (#109)

0.30.0 (September 22, 2021)

0.29.0 (September 15, 2021)

  • Applications: add consistency check for roles/scopes that may be in the process of being disabled, when updating an application (#102)
  • Applications: support for uploading application logos via the ApplicationsClient{}.UploadLogo() method(#103)
  • Directory Roles: add the DirectoryROlesClient{}.GetByTemplateId() method for retrieving roles by their template ID (#101)
  • User model: support EmployeeOrgData (#99)

0.28.2 (September 10, 2021)

  • Bug fix: Correctly handle HTTP responses after retries have been exhausted for a request, so that the correct status and error can be returned (#100)

0.28.1 (September 9, 2021)

  • Bug fix: Try to detect when running in Azure Cloud Shell and avoid specifying the tenant ID for Azure CLI authentication (#98)
  • Bug fix: Use the correct base64 decoder when parsing token claims (#97)

⚠️ BREAKING CHANGES:

  • Bug fix: User.PasswordPolicies has changed from a *string to a *StringNullWhenEmpty (#96)

0.28.0 (September 7, 2021)

0.27.0 (September 2, 2022)

  • Add some value types for ConditionalAccessPolicyState and InvitedUserType (#94)

0.26.0 (September 1, 2021)

  • auth.CachedAuthorizer - export this type and its Source field so that consumers can inspect it (#90)
  • Bugfix: set the struct tag for ServicePrincipal.Owners field so it is marshaled correctly (#91)

⚠️ BREAKING CHANGES:

  • The auth.CachedAuthorizer() function has been renamed to auth.NewCachedAuthorizer() (#90)

0.25.0 (August 24, 2021)

0.24.0 (August 17, 2021)

⚠️ BREAKING CHANGES:

  • The ID field of the Application, DirectoryRole, Group, ServicePrincipal and User models has been removed and is now a field of the embedded DirectoryObject struct (#86)
  • The Members and/or Owners fields of the Application, DirectoryRole, Group and ServicePrincipal models have changed from a *[]string to a *Members and *Owners respectively (#86)
    • The Members and Owners types are based on []DirectoryObject and have methods to marshal/unmarshal the ODataId fields of the contained DirectoryObjects
  • The AppendMember() and/or AppendOwner() methods of the Application, Group and ServicePrincipal models are no longer required and have been removed (#86)

0.23.1 (July 21, 2021)

  • Disable the default logger for retryablehttp.Client{} (#83)

0.23.0 (July 21, 2021)

  • Support for schema extension data for Groups and Users (#81)
    • Marshaling of schema extension data is handled automatically by the Group and User structs, enabling use of the existing Update() methods on the respective clients.
    • Unmarshaling is handled by either the provided msgraph.SchemaExtensionMap type, or a custom type supplied by the caller. Such a custom type must have an explicit UnmarshalJSON() method to satisfy the SchemaExtensionProperties interface. Both approaches have examples in the TestSchemaExtensionsClient() test.
  • Support for injecting and sequencing middleware functions for manipulating and/or copying requests and responses (#78)
    • See example.go for an example that logs requests and responses
  • Request retry handling for rate limiting, server errors and replication delays is now handled by go-retryablehttp (#78)
  • msgraph.Client{}.HttpClient is now exported so callers can supply their own http.Client (#78)

⚠️ BREAKING CHANGES:

  • Support odata.Query{} in more client methods (#80)
    • ApplicationsClient{}.Get()
    • ApplicationsClient{}.GetDeleted()
    • ApplicationsClient{}.ListExtensions()
    • ConditionalAccessPolicyClient{}.Get()
    • DirectoryAuditReportsClient{}.Get()
    • DomainsClient{}.List()
    • DomainsClient{}.Get()
    • GroupsClient{}.Get()
    • GroupsClient{}.GetDeleted()
    • MeClient{}.Get()
    • MeClient{}.GetProfile()
    • NamedLocationsClient{}.Get()
    • NamedLocationsClient{}.GetCountry()
    • NamedLocationsClient{}.GetIP()
    • SchemaExtensionsClient{}.Get()
    • ServicePrincipalsClient{}.Get()
    • ServicePrincipalsClient{}.ListAppRoleAssignments()
    • SignInReportsClient{}.Get()
    • UsersClient{}.Get()
    • UsersClient{}.GetDeleted()

0.22.0 (July 13, 2021)

  • msgraph.ServicePrincipal{} now supports the Description field (#77)
  • msgraph.ServicePrincipal{} now supports the Notes field (#77)
  • msgraph.ServicePrincipal{} now supports the SamlMetadataUrl field (#77)

⚠️ BREAKING CHANGES:

  • environments.ApiAppId is now a type alias
  • msgraph.ServicePrincipal{}.LoginUrl is now a StringNullWhenEmpty type (#77)
  • msgraph.ServicePrincipal{}.PreferredSingleSignOnMode is now a type alias pointer (formerly a string pointer) (#77)

0.21.0 (July 6, 2021)

  • msgraph.User{} now supports the AgeGroup field (#76)
  • msgraph.User{} now supports the ConsentProvidedForMinor field (#76)

⚠️ BREAKING CHANGES:

  • msgraph.Application{}.SignInAudience is now a pointer reference (#76)
  • msgraph.ServicePrincipal{}.SignInAudience is now a pointer reference (#76)
  • msgraph.Group{}.ResourceBehaviorOptions is now a custom type (#75)
  • msgraph.Group{}.ResourceProvisioningOptions is now a custom type (#75)
  • msgraph.Group{}.Theme is now a custom type (#75)
  • msgraph.Group{}.Visibility is now a custom type (#75)
  • msgraph.User{}.EmployeeId is now a StringNullWhenEmpty type (#76)
  • msgraph.User{}.FaxNumber is now a StringNullWhenEmpty type (#76)
  • msgraph.User{}.Mail is now a StringNullWhenEmpty type (#76)
  • msgraph.User{}.PreferredLanguage is now a StringNullWhenEmpty type (#76)
  • msgraph.ApplicationExtensionTargetObject is now a type alias (#76)
  • msgraph.AppRoleAllowedMemberType is now a type alias (#76)
  • msgraph.BodyType is now a type alias (#76)
  • msgraph.ExtensionSchemaPropertyDataType is now a type alias (#76)
  • msgraph.GroupType is now a type alias (#76)
  • msgraph.GroupMembershipClaim is now a type alias (#76)
  • msgraph.KeyCredentialType is now a type alias (#76)
  • msgraph.KeyCredentialUsage is now a type alias (#76)
  • msgraph.PermissionScopeType is now a type alias (#76)
  • msgraph.ResourceAccessType is now a type alias (#76)
  • msgraph.SignInAudience is now a type alias (#76)

0.20.0 (July 1, 2021)

  • Support the spa field for applications (#74)

0.19.0 (June 29, 2021)

⚠️ BREAKING CHANGES:

  • Support for passing the raw bytes of a PKCS#12 bundle when using client certificate authentication. This alters the method signature of auth.NewClientCertificateAuthorizer() but does not affect the use of a PFX file read from the filesystem. See #65 for details and example usage.

0.18.0 (June 22, 2021)

⚠️ BREAKING CHANGES:

  • This release introduces support for OData query parameters via a new type odata.Query{}. Instead of accepting just a filter string, all clients now accept an instance of odata.Query{} on relevant List methods which encapsulates any combination of odata queries such as $filter, $search, $top etc. All documented parameters are supported and wrapped lightly where appropriate. (#63)
  • Updating to this release will require changes to affected method calls, for example: 
    apps, status, err := appsClient.List(ctx, odata.Query{
	Filter: fmt.Sprintf("startsWith(displayName,'%s')", searchTerm),
	OrderBy: odata.OrderBy{
		Field:     "displayName",
		Direction: "asc",
	},
	Top: 10,
})
  • Where an empty filter string was previously specified, it should be replaced with an empty odata.Query{} struct: 
    apps, status, err := appsClient.List(ctx, odata.Query{})

0.17.0 (June 15, 2021)

⚠️ BREAKING CHANGES:

  • This release adds a new type alias StringNullWhenEmpty which has replaced several existing field string types
  • It enables zeroing field values that don't accept empty strings. See (#59) for details and example usage

0.16.0 (June 08, 2021)

BEHAVIORAL CHANGES:

  • This release implements a retry mechanism for some types of failed requests where the likely cause is indicated to be replication delays in Azure Active Directory (#57)
  • Client methods which retrieve, update or delete single, mutable objects will all exert this retry mechanism, and may take up to 2 minutes to return (successfully or not)
  • To opt out of this behavior, simply set the BaseClient.DisableRetries field to true on your client(s), for example: 
    client := msgraph.NewApplicationsClient(tenantId)
client.BaseClient.DisableRetries = true

0.15.0 (June 01, 2021)

  • Bug fix: Set correct OData types when updating named locations (#55)
  • Support for permanently deleting applications, groups and service principals (#54)
  • Add a NamedLocationsClient{}.Get() method (#56)

0.14.1 (May 28, 2021)

  • Bug fix: Restore a missing field OnPremisesImmutableId in the User model (#53)

0.14.0 (May 27, 2021)

0.13.0 (May 18, 2021)

  • Bug fix: Don't clear GroupMembershipClaims when nil for an Application (#40)
  • Bug fix: Handle empty OData error collections (#43)
  • Support for sending emails from the authenticated user principal or a specified user (#37)
  • Support for the ownedObjects endpoint for service principals (#38)
  • Support for managing identity providers (#41)
  • Support adding and removing application passwords (#44)
  • Support adding and removing service principal passwords (#45)

0.12.0 (April 23, 2021)

  • Support for managing Directory Roles (#30)
  • Support for activating Directory Roles (#31)
  • Support for App Role Assignments (#32)
  • Restore the retry mechanism previously introduced in v0.8.0
  • Use the odata package for parsing common error messages
  • Handle some additional errors, mainly for ioutil.Read*()
  • Add more ValidStatusFuncs for gracefully handling existing owner and member refs
  • Remove an unused struct field auth.ClientCredentialsConfig{}.Expires

⚠️ BREAKING CHANGES:

  • msgraph.Application{}.GroupMembershipClaims is now a custom type
  • msgraph.Application{}.SignInAudience is now a custom type
  • msgraph.AppRole{}.AllowedMemberTypes is now a custom type
  • msgraph.KeyCredential{}.Usage is now a custom type
  • msgraph.PermissionScope{}.Type is now a custom type
  • msgraph.ResourceAccess{}.Type is now a custom type
  • msgraph.ServicePrincipal{}.SignInAudience is now a custom type

0.11.0 (April 13, 2021)

0.10.0 (April 10, 2021)

⚠️ BREAKING CHANGES:

  • This release refactors various packages to make for a better import experience.
  • base, clients and models packages have been combined into a single msgraph package.
  • base/aadgraph package has been moved to aadgraph.
  • base/odata package has been moved to odata.

0.9.0 (March 1, 2021)

0.8.0 (February 2, 2021)

  • Exponential backoff for handling rate limited and failed requests to MS Graph and AAD Graph

0.7.0 (January 27, 2021)

  • Check for supported az command version when using Azure CLI authentication
  • Remove dependency on deprecated package golang.org/x/oauth2/jws
  • Merge the auth/internal/microsoft package into auth now that it's stable
  • Validate the MSI auth configuration before returning an MsiAuthorizer - ensure the metadata endpoint is reachable

0.6.0 (January 26, 2021)

  • Support authentication using VM managed identity.
  • Add App ID for Teams Services API.

0.5.0 (January 24, 2021)

  • All responses from Microsoft Graph and Azure Active Directory Graph are now parsed for OData metadata. Calls to base.Client.Delete(), base.Client.Get(), base.Client.Patch(), base.Client.Post() and base.client.Put() each now return OData metadata in addition to the complete response.
  • Support for v1 and v2 access tokens from Microsoft Identity Platform. Defaults to v2 tokens.
  • Support for acquiring access tokens for Microsoft Graph or Azure Active Directory graph. Since the MSID platform only supports scopes from a single API per token, these must be requested separately if using both APIs.
  • Token claims parsed now includes scopes (scp claim)
  • Export app IDs for several published APIs from Microsoft. These can be reliably consumed as environments.PublishedApis.
  • Support for querying Azure Active Directory Graph API
    • This is intended as a stopgap solution for when it's not possible to perform an action using Microsoft Graph.
    • A number of endpoints do not yet have equivalents in MS Graph, notably those used by the Azure Portal.
    • There is only a base client at present.

⚠️ BREAKING CHANGES:

  • Method signature for auth.Config.NewAuthorizer() has changed to include the API to request tokens for.
  • Corresponding function signatures for auth.NewAzureCliAuthorizer(), auth.NewClientCertificateAuthorizer() and auth.NewClientSecretAuthorizer() also now include an api argument.
  • The auth.NewAzureCliConfig() function also now includes an api argument.
  • Functions implementing base.ValidStatusFunc must now accept a second argument as the pointer to a base.odata.OData struct.
  • The environments.MsGraphEndpoint type has been removed in favor of environments.ApiEndpoint.
  • The endpoint argument for models.Application.AppendOwner(), models.Group.AppendMember() and models.Group.AppendOwner() methods should now be an environments.ApiEndpoint.
  • The environments package now exports Api structs for each national cloud and API combination, e.g. environments.MsGraphGermany.
  • The Environment structs exports in the environments package have been changed to reference Apis and no longer include MsGraphEndpoint.

0.4.0 (January 19, 2021)

  • Adds the ServicePrincipalsClient.ListGroupMemberships() method.
  • Adds the UsersClient.ListGroupMemberships() method.
  • Pagination handling: multiple pages of results with OData metadata are now automatically retrieved and merged together in the BaseClient for GET requests.

0.3.0 (January 18, 2021)

  • Methods on models.ApplcationApi to manage Oauth2PermissionScopes.
  • Tests for auth and clients packages.

0.2.0 (January 15, 2021)

Add support for all national clouds:

  • Global: graph.microsoft.com
  • Germany: graph.microsoft.de
  • China: microsoftgraph.chinacloudapi.cn
  • US Government L4: graph.microsoft.us
  • US Government L5 (DOD): dod-graph.microsoft.us

Note that this is a breaking change from v0.1.0 as the signatures for all the clients have changed. If you are using the global cloud, you do not need to specify this when creating a new client as it is the default. However, you do need to specify a cloud environment when acquiring an access token using auth.NewAuthorizer.

0.1.0 (January 13, 2021)

Initial release. Working support for:

  • Applications
  • Domains
  • Groups
  • Service Principals
  • Users