Skip to main content

How to Use the Change Password Form

This page covers how to link to the "Change password" form from external applications.

The "Change password" form currently allows a user to sign in and change their password to a new one. The form checks that the new password is valid, and can redirect the user to a specified URL afterward.

The base URL is https://my.id.service/changePassword (case sensitive). You can add optional query parameters to the URL, then redirect the user to the generated URL.

Supported query parameters:

ParameterValueSupported after version
displayDisplay/layout selector, corresponding to the OpenID Connect display parameter.3.24
id_tokenA valid user ID token. With this, the user doesn't need to enter a username — only their password (and possibly other required authentication methods). Providing the ID token also lets OAuth2/OIDC client-specific customisations be applied to the user interface.3.24
localePreferred initial language displayed, for example fi, en, or sv.3.24
usernameOptional sign-in name (username, email, or phone number) to pre-fill in the form.
nsOptional namespace code to pre-fill in the form.
ruOptional Return URL, where the user is directed after changing their password. It must meet the requirements set in configuration.

Customisation of the user interface

The operation and look of the "Change Password" pages can be customised.

Operational changes

The operation of the pages can be customised in the Management UI, either system-wide via System Preferences → Base settings → Change password, or at the OAuth client level via OpenID Connect clients → Edit → Change user password.

OIDC client's Change user password tab, with Logo, Namespace field, and Return link settings

Branding with style changes

The style can be customised with CSS — see User-interface styling.