Backend APIs: Updating device’s display_name input field restrictions (Announcement update)

Non breaking change.

This announcement replaces the previously announced update: https://support.futurae.com/hc/en-us/articles/9845217773330-Backend-APIs-Updating-device-s-display-name-input-field-restrictions

When will this change happen?

March 1st.

What is changing?

Additional Input restrictions are going to be applied to the device resource’s display_name field of the Auth and Admin APIs.

This change will improve the service’s security further. 

The input restrictions applied to this field will be:

• Maximum length of field is 100 characters
• Unicode letters (Unicode L character class)
• Numbers ([0-9])
• White space character
• Special characters - + / . ( )

To contextualize this change, the device’s display_name is a string used to identify the authenticator device. More details at https://www.futurae.com/docs/api/admin/#device.

Existing display_name records that contain invalid characters, will be automatically sanitized by removing the invalid characters.

If a device display_name containing invalid characters is provided to the Modify User Device endpoints of the Auth or Admin API, the provided display_name value will be automatically sanitized according to the above rules, and the request will be replied with 200 OK.

Does this change have any impact on my Futurae API integration?

This change does not require any action and does not impact existing Futurae API integrations. However, existing device display_name entries containing invalid characters will be automatically sanitized once this update is released.