API changes for v2 API, October 30 to November 6
This week's updates to the mittwald API include the removal of two schemas, the addition of several new endpoints and optional request properties, as well as enhancements to response properties and non-success status codes across various operations.
Summary
- The schemas
de.mittwald.v1.directus.Domainandde.mittwald.v1.directus.EmailInboxhave been removed from the API components. - The optional property
/items/accessProtectionhas been added to the response with a200status for thePOST /v2/actions/list-ingresses-compatible-with-certificateoperation. - A non-success response with the status
403has been added for theGET /v2/app-installations/{appInstallationId}operation. - The new optional request property
autoUpdatesActivatedhas been added to thePATCH /v2/app-installations/{appInstallationId}operation. - The required property
/items/stagingAllowedhas been added to the response with a200status for both theGET /v2/appsandGET /v2/apps/{appId}operations. - The optional property
passkeyChallengeand the required propertyavailableSecondFactorshave been added to the response with a202status for thePOST /v2/authenticateoperation. - The new optional request property
passkeyCredentialhas been added to thePOST /v2/authenticate-mfa,DELETE /v2/users/self,DELETE /v2/users/self/credentials/mfa,PUT /v2/users/self/credentials/mfa, andPUT /v2/users/self/credentials/passwordoperations. - The request property
multiFactorCodehas become optional for thePOST /v2/authenticate-mfa,DELETE /v2/users/self/credentials/mfa, andPUT /v2/users/self/credentials/mfaoperations. - The following endpoints have been added:
POST /v2/authenticate-passkeyfor authenticating with a passkey.POST /v2/notification-settings/actions/resetfor resetting notification settings to their defaults.POST /v2/passkey-challengesfor creating a challenge for a passkey login.POST /v2/users/self/passkey-challengesfor creating a challenge to confirm an action with a passkey.POST /v2/users/self/passkey-registration-challengesfor creating a challenge to register a new passkey.GET /v2/users/self/passkeysfor getting registered passkeys.POST /v2/users/self/passkeysfor registering a new passkey.DELETE /v2/users/self/passkeys/{passkeyId}for deleting a passkey.PATCH /v2/users/self/passkeys/{passkeyId}for renaming a passkey.
- A non-success response with the status
403has been added for the following operations:GET /v2/cronjobs/{cronjobId}GET /v2/customer-invites/{customerInviteId}GET /v2/customers/{customerId}/membershipsGET /v2/mysql-databases/{mysqlDatabaseId}POST /v2/projects/{projectId}/dns-zonesGET /v2/redis-databases/{redisDatabaseId}POST /v2/registerGET /v2/project-invites/{projectInviteId}GET /v2/users/{userId}
- A non-success response with the status
400has been added for theGET /v2/users/{userId}operation. - A non-success response with the status
401has been added for theGET /v2/users/{userId}operation.
Disclaimer: This summary is AI-generated. If you find any discrepancies, please refer to the detailed changes below.
Detailed changes
Changes in ""
-
removed the schema 'de.mittwald.v1.directus.Domain'
-
removed the schema 'de.mittwald.v1.directus.EmailInbox'
For details, refer to the unknown operation endpoint.
Changes in "List Ingresses compatible with a certificate"
- added the optional property '/items/accessProtection' to the response with the '200' status
For details, refer to the POST/v2/
Changes in "Get an app installation"
- added the non-success response with the status '403'
For details, refer to the GET/v2/
Changes in "Update properties belonging to an app installation"
- added the new optional request property 'autoUpdatesActivated'
For details, refer to the PATCH/v2/
Changes in "List apps"
- added the required property '/items/stagingAllowed' to the response with the '200' status
For details, refer to the GET/v2/
Changes in "Get an app"
- added the required property 'stagingAllowed' to the response with the '200' status
For details, refer to the GET/v2/
Changes in "Authenticate yourself to get an access token"
-
added the optional property 'passkeyChallenge' to the response with the '202' status
-
added the required property 'availableSecondFactors' to the response with the '202' status
For details, refer to the POST/v2/
Changes in "Validate your second factor"
-
added the new optional request property 'passkeyCredential'
-
the request property 'multiFactorCode' became optional
For details, refer to the POST/v2/
Changes in "Authenticate yourself with a passkey to get an access token"
- endpoint added
For details, refer to the POST/v2/
Changes in "Get a cronjob"
- added the non-success response with the status '403'
For details, refer to the GET/v2/
Changes in "Get a customer invite"
- added the non-success response with the status '403'
For details, refer to the GET/v2/
Changes in "List Memberships belonging to a Customer"
- added the non-success response with the status '403'
For details, refer to the GET/v2/
Changes in "List Ingresses"
- added the optional property '/items/accessProtection' to the response with the '200' status
For details, refer to the GET/v2/
Changes in "Get an Ingress"
- added the optional property 'accessProtection' to the response with the '200' status
For details, refer to the GET/v2/
Changes in "Get a MySQL database"
- added the non-success response with the status '403'
For details, refer to the GET/v2/
Changes in "Reset notification settings to their defaults"
- endpoint added
For details, refer to the POST/v2/
Changes in "Create a challenge for a passkey login"
- endpoint added
For details, refer to the POST/v2/
Changes in "Get a ProjectInvite"
- added the non-success response with the status '403'
For details, refer to the GET/v2/
Changes in "Get the activities of a project"
- added the optional property '/items/credential' to the response with the '200' status
For details, refer to the GET/v2/
Changes in "Create a DNS Zone for a verified Ingress in a Project"
- added the non-success response with the status '403'
For details, refer to the POST/v2/
Changes in "Get a Redis database"
- added the non-success response with the status '403'
For details, refer to the GET/v2/
Changes in "Register with email and password"
- added the non-success response with the status '403'
For details, refer to the POST/v2/
Changes in "Delete your account and all your personal data"
- added the new optional request property 'passkeyCredential'
For details, refer to the DELETE/v2/
Changes in "Disable Multi Factor Authentication"
-
added the new optional request property 'passkeyCredential'
-
the request property 'multiFactorCode' became optional
For details, refer to the DELETE/v2/
Changes in "Reset RecoveryCodes for MFA"
-
added the new optional request property 'passkeyCredential'
-
the request property 'multiFactorCode' became optional
For details, refer to the PUT/v2/
Changes in "Change your password"
- added the new optional request property 'passkeyCredential'
For details, refer to the PUT/v2/
Changes in "Create a challenge to confirm an action with a passkey"
- endpoint added
For details, refer to the POST/v2/
Changes in "Create a challenge to register a new passkey"
- endpoint added
For details, refer to the POST/v2/
Changes in "Get your registered passkeys"
- endpoint added
For details, refer to the GET/v2/
Changes in "Register a new passkey"
- endpoint added
For details, refer to the POST/v2/
Changes in "Delete a passkey"
- endpoint added
For details, refer to the DELETE/v2/
Changes in "Rename a passkey"
- endpoint added
For details, refer to the PATCH/v2/
Changes in "Get profile information for a user"
-
added the non-success response with the status '400'
-
added the non-success response with the status '401'
For details, refer to the GET/v2/
Client package releases
mittwald PHP SDK v2.2.23 Release Summary
The mittwald PHP SDK has been updated to version 2.2.23, introducing several new features and improvements. This release includes a dedicated endpoint for resetting notification settings, enhanced activity log tracing with credential identification, and staging flags for application models. Additionally, client-side error handling has been improved with typed response classes for various HTTP status codes, and schema namespaces have been updated to align with the Redirectus service.
New Features
- Reset Notification Settings: A new
notificationsResetNotificationSettingsendpoint inNotificationClientallows users to reset all notification channel settings to their defaults. - Activity Log Credential Tracking: The
LogEntryschema now includes acredentialfield to track the authentication method used for actions. - Application Staging Support: The
Appschema now features astagingAllowedproperty to indicate if stagingAppInstallationinstances can be created.
Improvements & Updates
- Enhanced Error Handling: Typed response classes for common HTTP status codes have been added to improve exception handling:
GetUser: Handles400 Bad Requestand401 Unauthorizedresponses.Register: Handles403 Forbiddenresponses.DnsCreateProjectDnsZone: Handles403 Forbiddenresponses.
- DNS Zone Creation Documentation: Clarified documentation for creating DNS subzones.
- Schema Namespace Migration: The
DomainandEmailInboxmodels have been moved to theRedirectusnamespace.
For more details, visit the release page.
mittwald PHP SDK v2.2.22 Release Summary
The mittwald PHP SDK has been updated to version 2.2.22. This release introduces significant new features and enhancements to improve user authentication and application management.
Features Added
- Passkey (WebAuthn) Support: Comprehensive support for passkey lifecycle management, including endpoints for creating, authenticating, registering, challenging, confirming, and deleting passkeys.
- Automatic App Updates: A new
autoUpdatesActivatedboolean field in thePatchAppinstallationclient allows for automatic version updates of app installations.
Enhancements
- MFA & Authentication Flow:
- The
multiFactorCodeis now optional in MFA and password change requests. - Added
passkeyCredentialsupport toAuthenticateMfaandChangePasswordrequests. - Updated
AuthenticateAcceptedResponseto includeavailableSecondFactorsandpasskeyChallengefor dynamic MFA method discovery.
- The
- HTTP Status Handling: Introduced dedicated
403 Forbiddenresponse classes for operations such asGetAppinstallation,GetCronjob,GetMysqlDatabase, andGetRedisDatabase.
For more details, visit the release page.
mittwald PHP SDK v2.2.21 Release Summary
The mittwald PHP SDK has been updated to version v2.2.21. This release includes several bug fixes, improvements, and new features.
Bug Fixes & Improvements
- Enhanced handling for HTTP 403 (Forbidden) status codes in the Customer and Project client modules.
- Updated
CustomerClientImplandProjectClientImplto map 403 responses to newForbiddenResponseclasses for specific endpoints, improving error handling clarity.
New Features
- Ingress Access Protection Configuration:
- Added schema support for configuring Ingress access protection, allowing detailed control over authentication and authorization.
- Introduced support for
mStudioand externalOpenID Connect (OIDC)authentication providers. - Implemented
PathAccessProtectionandAllPathsAccessProtectionmodels for defining protection scope. - Added
AccessProtectionRulesfor setting access policies based on email addresses, domains, project memberships, and authenticated user access. - Extended the
Ingressmodel with theaccessProtectionproperty to support these configurations.
For more details, visit the release page.
mittwald JavaScript SDK Release 4.517.0
The mittwald JavaScript SDK has been updated to version 4.517.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub: mittwald JavaScript SDK 4.517.0.
mittwald JavaScript SDK Release 4.516.0
The mittwald JavaScript SDK has been updated to version 4.516.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub.
mittwald JavaScript SDK Release 4.515.0
The mittwald JavaScript SDK has been updated to version 4.515.0. This release includes the following feature:
- Updated the generated client to enhance functionality (commit 67e4c89).
For more details, you can view the release on GitHub: mittwald JavaScript SDK 4.515.0.
mittwald JavaScript SDK Release 4.514.0
The mittwald JavaScript SDK has been updated to version 4.514.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub here.
mittwald JavaScript SDK Release 4.513.0
The mittwald JavaScript SDK has been updated to version 4.513.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub.
mittwald JavaScript SDK Release 4.512.0
The mittwald JavaScript SDK has been updated to version 4.512.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub.
mittwald JavaScript SDK Release 4.511.0
The mittwald JavaScript SDK has been updated to version 4.511.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub: mittwald JavaScript SDK 4.511.0.
mittwald JavaScript SDK Release 4.510.0
The mittwald JavaScript SDK has been updated to version 4.510.0. This release includes the following feature:
- Updated the generated client to enhance functionality and performance (commit 6f2aca2).
For more details, you can view the release on GitHub.
mittwald JavaScript SDK Release 4.509.0
The mittwald JavaScript SDK has been updated to version 4.509.0. This release includes the following feature:
- Updated the generated client to enhance functionality and performance. For more details, refer to commit 85f7aaa.
For further information, please visit the release page.
mittwald JavaScript SDK Release 4.508.0
The mittwald JavaScript SDK has been updated to version 4.508.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub: mittwald JavaScript SDK 4.508.0.