Customers: Federation
Miguel Giraldo avatar
Written by Miguel Giraldo
Updated over a week ago

This module offers the possibility to incorporate in a website a user registration managed by Mediastream, through a brief and secure integration with our player, so it is easier to identify the end user through the consumption of content; the concept of federations allows to group users according to the domain and / or brand within the same account.

The configuration of the forms is characterized by using mainly email, dns, RRSS and different styles in the widgets.

Federation Email Domains

To configure a login, a federation must be previously configured, this can be found in Customers> Federation Email Domains, this determines the context to which the users that register using this method will be related to.

In this group, click on +Create New Domain, once the new interface is displayed, add the domain referrer and click on Save, when doing so, platform automatically generates the keys to configure the respective TXT records within the DNS server, once created, they take up to 72 hours to be verified (red box).

When these keys are verified, it will be indicated with a green icon in the status column.

If they are not approved, they will be marked with an X.


Federation Group

In this module, you can enter as many groups of federations, brands or registries as necessary, the users registered within each group will be independent and will be created with different customer_id.

To create a new group, click on +Create New Federation Group, this changes the interface as follows:

Then, the fields must be filled in as follows:

1- Basic Information

Enter a name and description for the federation group.

2- Register Form

In this section the registration fields are entered, by default, platform delivers 4 fields, these are: email, password, first name and last name.

Field types are always assigned to text, textarea, checkbox or date.

You can assign an order (1), the name of the field created (2), indicate the type of field (3), assign the label that the user will see when displaying the registration form (4), the option to assign it as required and whether or not it will be editable for the end user (5), additionally, the fields can be deleted by simply clicking on the red icon with the trash can on the right.

Note, the email and password fields are always set as required, only the password is editable, they CANNOT BE DELETED.

If more fields are required, just click on +Add Field located at the top left, the field will appear in the list in which you can add the options birthday (date of birth) that is assigned to date type, gender (gender) assigned to default selection and metadata, the latter gives the option to add X amount of fields as needed.

Sample Image:

3- Social Integration

It allows you to integrate a login by social networks, in this case Google and Facebook, to do this you must do the following:

Google: To obtain the Client ID and Client Secret it must be done from the google developers page https://console.developers.google.com/, from there the respective keys are obtained from the Credentials section, remember to go through the whole process of creating the project to obtain the required IDs.

Facebook: As with Google, the required credentials, Public Key (App ID) and Private Key (App Secret) are obtained from the Meta developer page:  https://developers.facebook.com/apps, from the settings, in the Basic options.

4- Security

It responds to the section where the different domains where the widgets will work must be configured. You can see the following fields:

  • Domains: the domains allowed for the Federation group, just write them down and press enter.

  • Register options: is used to select whether or not to validate the email before login.

  • Session options: in this box we indicate the number of days for the inactive sessions to expire, by default 30 days are shown initially.

  • ReCaptcha v2 Integration: if you want to activate the captcha option to prevent bots from filling out the forms, you can do it in this section, where you must indicate the type of captcha Invisible or checkbox, as well as enter the Site Key and Secret Key that you get from the Google account.

reCAPTCHA Invisible

reCAPTCHA checkbox

  • Password options: Here you configure the different options required for password generation, such as the minimum and maximum number of characters, upper and lower case letters, numbers and special characters, which can be configured as you wish.

5- Callbacks

In this section the endpoints are configured to receive the Login and Logout actions, which deliver a token as a response through a GET request, together with the parameter that indicates whether it is login or logout, this is sent to the API where the information of the authenticated user is obtained.

6- Email

This section is used to configure a welcome, confirmation and password recovery messages sent to the authenticated user, the emails will not be sent as long as the domain is not verified.

Initially you must add the associated email in Federation Email Domains in order to send the email, along with the sender's name, the sender email must contain exactly the same domain assigned to the federation, including upper and lower case:

Emails can be edited from email templates according to the following keywords:

  • {first_name}

  • {last_name}

  • {email}

  • {url}

  • {federation_name}

These tags will be interpreted based on the values of the user and Federation registry, according to the selected section, the html text can be edited giving the possibility to enter links, styles, etc.

Once you have finished the configuration process with the required fields, do not forget to save the changes.


If you have any additional questions, do not hesitate to contact us via chat.

Att: The Mediastream team

Did this answer your question?