Migration from 1.8.x to 1.9.x

This guide contains instructions for migration from PowerAuth Cloud version 1.8.x to version 1.9.0.

REST API

User Operations Listing

A new API endpoint GET /v2/operations has been added to retrieve a list of operations associated with a user. This endpoint supports optional filtering by registration ID and provides paginated results.

Fetch Number of Unique Active Users

A new API endpoint GET /admin/telemetry/applications/{id}/users has been added to fetch the number of unique active users of an application in specified number of days from the past until today.

Updates in Callback Management API

New parameters added to callback management API:

• retentionPeriod - specifies how long should be the callback event records retained in ISO 8601 duration format, for example P30D
• initialBackoff - specifies the initial backoff for callback delivery in ISO 8601 duration format, for example PT2.5S
• maxAttempts - specifies the maximum attempts for sending the callback, default: 1

New Endpoints for Application Configuration

Following endpoints have been added:

• GET /admin/applications/{id}/config - get application configuration
• POST /admin/applications/{id}/config - create application configuration
• DELETE /admin/applications/{id}/config - delete application configuration

Added Commit Phase Parameter for New Registrations

The endpoint POST /v2/registrations has a new parameter commitPhase which is used for specifying when the registration should be committed during the registration flow. Possible values are: ON_KEY_EXCHANGE and ON_COMMIT (default).

The parameter otpValidation is deprecated. Use the otp parameter during new device registration or registration commit to control the OTP check. The commitPhase parameter is now used to control the commit phase.

Docker Environment

Environment Variables for Proximity Check Configuration

PowerAuth Server introduced new application properties to adjust parameters for the TOTP generation and validation algorithm in the proximity check process. To reflect that, a new environment variables are available.

• POWERAUTH_SERVER_PROXIMITY_CHECK_OTP_LENGTH
• POWERAUTH_SERVER_PROXIMITY_CHECK_OTP_STEP_DURATION
• POWERAUTH_SERVER_PROXIMITY_CHECK_OTP_STEP_COUNT

Environment Variables for Callback Processing Configuration

The PowerAuth Server now implements an outbox pattern with a circuit breaker for callback processing. This enhancement introduces additional configuration options, including retry policies, retention periods, circuit breaker parameters, and thread pool settings for asynchronous processing. The following environment variables are now available:

• POWERAUTH_SERVER_CALLBACKS_DEFAULT_MAX_ATTEMPTS
• POWERAUTH_SERVER_CALLBACKS_DEFAULT_RETENTION_PERIOD
• POWERAUTH_SERVER_CALLBACKS_DEFAULT_INITIAL_BACKOFF
• POWERAUTH_SERVER_CALLBACKS_MAX_BACKOFF
• POWERAUTH_SERVER_CALLBACKS_BACKOFF_MULTIPLIER
• POWERAUTH_SERVER_CALLBACKS_PENDING_CALLBACK_URL_EVENTS_DISPATCH_LIMIT
• POWERAUTH_SERVER_CALLBACKS_THREAD_POOL_CORE_SIZE
• POWERAUTH_SERVER_CALLBACKS_THREAD_POOL_MAX_SIZE
• POWERAUTH_SERVER_CALLBACKS_THREAD_POOL_QUEUE_CAPACITY
• POWERAUTH_SERVER_CALLBACKS_FORCE_RERUN_PERIOD
• POWERAUTH_SERVER_CALLBACKS_FAILURE_THRESHOLD
• POWERAUTH_SERVER_CALLBACKS_FAILURE_RESET_TIMEOUT
• POWERAUTH_SERVER_CALLBACKS_CLIENTS_CACHE_REFRESH_AFTER_WRITE