Registration Form Customization

The edu-ID registration form and login form can be customized to improve integration with edu-ID enabled services.

Registration of a minimal edu-ID account

After the initial creation of a SWITCH edu-ID and the verification of the email address, the user is sent back to the SP. This is the default behavior.

In rare cases, the user might want to proceed to the edu-ID profile page after the successful registration of an edu-ID instead of the SP. The user will find the link to the profile page in the email that was sent to her/him during in the email-address verification process.

Customization of the edu-ID login and registration pages

A user who intends to use a service but does not have an edu-ID account can be immediately redirected to edu-ID registration form to create a SWITCH edu-ID. The registration form is hosted by SWITCH and therefore looks different then the service/web page that the user is supposed to access with his edu-ID. In order to harmonize the appearance of the and thus improve the user experience for new users in the registration process, the SWITCH edu-ID login and registration form can be customized to some extent. The purpose of the customization is to clarify the context of the registration and login forms, provide the user with necessary background information and offer help to the user in case he/she is stuck or has questions.

Customization is currently applicable for the following edu-ID web pages:

  • Login page at SWITCH edu-ID IdP
  • Registration page(s) where the user creates an edu-ID account by providing his name, email address and password

Customized Login Form

dialog-ext-placeholder

Three sections can be customized

  • login-logo-url: A URL to a logo (ideally in in png format). Max height: 60px, Width: 30px - 400px
  • login-name: A title text of max 1 line.
  • login-outro: A description text with more detailed context information in html format. The text length can be multiple lines.

Customized Registration Form

dialog-ext-complex-placeholder

Three sections can be customized

  • reg-logo-url: A URL to a logo (ideally in in png format). Max height: 60px, Width: 30px - 400px
  • reg-name: A short description. The text length should be max 1 line. Filename: reg-intro.txt, reg-intro-LANG.txt
  • reg-intro: A description text with more detailed context information in html format. The text length can be multiple lines.
  • reg-tou-amendment: A text that allows to (exclusively( skipping the user consent for the attribute release on first login to the service. It should basically say that the user agrees on first login (when) that the above user information (what) is sent to the service (where) for what purpose (why).
  • reg-outro: A description text with more detailed context information in html format. The text length can be multiple lines.
  • returnURL: URL to send the user back to after creating an edu-ID account. It is also possible to directly force the user after account creation to login directly with his newly created edu-ID account and send him to a Shibboleth protected page.

Register a custom view for your SP

  1. Complete the following information
    entityID=
    returnURL.[en|it|fr|de]=
    login-logo-url.[en|it|fr|de]=
    login-logo-link-url.[en|it|fr|de]=
    login-name.[en|it|fr|de]=
    login-outro.[en|it|fr|de]= reg-logo-url.[en|it|fr|de]= reg-logo-link-url.[en|it|fr|de]= reg-name.[en|it|fr|de]= reg-tou-amendment.[en|it|fr|de]= reg-intro.[en|it|fr|de]= reg-outro.[en|it|fr|de]=
    An example could look like:
    entityID=https://evento-dev.zhaw.ch/CLX.Evento/AuthServices
    returnURL.de=https://eventoweb-dev.zhaw.ch/de/onla/OnlineAnmeldung_ZHAW.html
    returnURL.en=https://eventoweb-dev.zhaw.ch/en/onla/OnlineAnmeldung_ZHAW.html
    login-logo-url.de=https://www.zhaw.ch/images/logo.png
    login-logo-url.en=https://www.zhaw.ch/images/logo.png
    login-logo-link-url.de=https://www.zhaw.ch/
    login-logo-link-url.en=https://www.zhaw.ch/
    login-name.de=SWITCH edu-ID Konto Eröffnen 
    login-name.en=Create a SWITCH edu-ID account
    login-outro.de=Für die Anmeldung an der ZHAW benötigen Sie einen SWITCH edu-ID Benutzer-Account.<br>Wenn Sie noch keinen Benutzer-Account haben, können Sie sich jetzt einen erstellen.
    login-outro.en=For registration at ZHAW you need an SWITCH edu-ID account.<br>If you don\'t have one already, please create it now.
    reg-logo-link-url.de=https://www.zhaw.ch/
    reg-logo-link-url.en=https://www.zhaw.ch/
    reg-logo-url.de=https://www.zhaw.ch/images/logo.png
    reg-logo-url.en=https://www.zhaw.ch/images/logo.png
    reg-name.de=Online Anmeldung
    reg-name.en=Student Registration
    reg-tou-amendment.de=Bei der ersten Anmeldung mit meiner edu-ID werden die oben eingegeben Daten (ausser Passwort und CAPTCHA) zu Zwecken der Online Anmeldung an die ZHAW Hochschuladministration gesendet.
    reg-tou-amendment.en=The first time I login with my edu-ID account the data I enter above (except password and CAPTCHA) will be sent to ZHAW student administration for the purpose of the student registration.
    reg-intro.de=Für die Anmeldung bei der ZHAW müssen Sie zunächst eine SWITCH edu-ID erstellen.
    reg-intro.en=For registration at ZHAW you need to create a SWITCH edu-ID first.
    reg-outro.de=Um die Registrierung abzuschliessen zu können, erhalten Sie eine E-Mail mit einem Bestätigungslink. Die Nutzungsbedingungen werden Ihnen per E-Mail zugeschickt, sobald Ihr Konto erfolgreich erstellt wurde.
    reg-outro.en=To complete the account registration you will get an email with a confirmation link. The Terms of Use will also be sent to you by email when your account has been successfully created.
    
  2. Send the above information to with the request to register the custom view.
    SWITCH then will need 1-2 working days to create the custom view.
    The custom view will typically first be created on the test instance of the edu-ID.

Please note that all text should be UTF-8 encoded. HTML tags can be used but we recommend not to use other tags than: p, br, strong, a.
The supported languages include for now only 'en', 'fr', 'de' and 'it'.

Use/link to the custom view

The custom view will automatically be displayed on the edu-ID login page when a user is accessing the SP for which a custom view was defined. When the user then clicks on the "Create Account" button, the custom view also will automatically be shown on the registration page.

If you prefer the process to start at the registration page directly (by linking to the edu-ID registration page directly), the custom view can be shown by adding the following parameters to the URL of the registration page: https://eduid.ch/web/registration

  • providerId (or deprecated 'entityID'): the URL-encoded entityID of the service (e.g. https://my.service/shibboleth)
  • target (or deprecated 'return'): URL to send the user to after registration/login
  • lang (optional): the preferred language of the registration form. Only the following values are supported: 'en', 'fr', 'de' or 'it'

Example: the customised registration page of swissbib.ch in French, that will finally redirect the user "to this": https://login.eduid.ch/idp/profile/SAML2/Unsolicited/SSO?providerId=https%3A%2F%2Fwww.swissbib.ch%2Fshibboleth&target=https%3A%2F%2Fwww.swissbib.ch%2FNationalLicences redirect url

https://eduid.ch/web/registration/method/?providerId=https%3A%2F%2Fwww.swissbib.ch%2Fshibboleth&lang=fr

Please have a look at the edu-ID Link Composer to easily generate these (and more) URLs related to edu-ID login and registration flows.

Language Support

The language for the login and registration page is selected as follows, and in this order:

  1. based on the availability of the custom language files. If a custom view only includes english [en] and German [de], the user won't be available to select French [fr]
  2. based on the lang HTTP GET parameter of the registration form. This parameter sets a edu-ID language cookie. If the lang parameter is not set:
  3. based on any 'lang' cookie that the user previously set for the domain eduid.ch
  4. based on the language preferences set in the browser (which sets the HTTP_ACCEPT_LANGUAGE header).

The user can select the preferred language in the login and the registration form. This then sets the edu-ID language cookie.