Social Sign On module will add the possibilty to login in to you ExpressionEngine site via your favorite Social Media site. (MSM Ready)
currently supported
Make sure your system meets the minimum requirements:
This module is using a license field to check if the license for the module is valid or not. On addons.reinos.nl you can check your license and add your valid domains.
In the Module CP you can enter then your license
When you enter a wrong license, the module will not work and it shows you an warning
On a local environment, like *.dev
*.local
*.localhost
*.test
the license will be valid for the testing and building new sites.
As already know the SSO module will allow users to login on your site via a social provider. Below a couple of cases how the module will handle the login and what it will do.
no
there will be shown an error on the screen and the user will be asked to enter a new email address.yes
the user will be logged in on the account that already exists on the EE site.On the CP page you can modify a couple of things.
Also you can edit your settings per provider (social site) and per site there are different settings
Name | Description |
---|---|
Enabled | Is the provider enabled or not |
ID | Your API ID |
Secret | Your API Secret |
Scope | For what data should be asked for permission Google Scopes |
To get the API keys follow the following steps:
Name | Description |
---|---|
Enabled | Is the provider enabled or not |
ID | Your API ID |
Secret | Your API Secret |
Scope | For what data should be asked for permission Facebook Scopes |
To get the API keys follow the following steps:
Name | Description |
---|---|
Enabled | Is the provider enabled or not |
ID | Your API ID |
Secret | Your API Secret |
To get the API keys follow the following steps:
Name | Description |
---|---|
Enabled | Is the provider enabled or not |
ID | Your API ID |
Secret | Your API Secret |
To get the API keys follow the following steps:
To customise the email template, you can alter the template in the Template Manager -> System Templates -> Email and look for SSO.
With the login_links
tag you can add the provider to your website
{exp:sso:login_links}
Below are the Tag Parameters. Those parameters can be used in the tag described above, Default to the current_url
.
the return url where the user will be redirected after logged in
return=""
Give a return url for when the email is unavailable from the social channel. Default to the return
param
no_email_return=""
the return url for when the user is new. Default to the return
param
new_member_return=""
Below are the variables. Those variables can be used in the tag described above
The login link to a provider
{exp:sso:login_links}
{provider_link}
{/exp:sso:login_links}
The Provider name
{exp:sso:login_links}
{provider_name}
{/exp:sso:login_links}
With the linked_providers
tag you can connect multiple providers to your account
{exp:sso:linked_providers}
Below are the Tag Parameters. Those parameters can be used in the tag described above, Default to the current_url
.
the return url where the user will be redirected after logged in
return=""
Below are the variables. Those variables can be used in the tag described above
The connect link to a provider
{exp:sso:linked_providers}
{provider_connect_link}
{/exp:sso:linked_providers}
The disconnect link to a provider
{exp:sso:linked_providers}
{provider_disconnect_link}
{/exp:sso:linked_providers}
The Provider name
{exp:sso:linked_providers}
{provider_name}
{/exp:sso:linked_providers}
Variable to check if a user is connected
{exp:sso:linked_providers}
{if provider_is_connected}
<a href="{provider_disconnect_link}">Disconnect from {provider_name}</a>
{if:else}
<a href="{provider_connect_link}">Link with {provider_name}</a>
{/if}
{/exp:sso:linked_providers}
With the login_error
tag you can print the login error on your screen
{exp:sso:login_error}
With the email_error
tag you can print the email error on your screen (if you collect a email if needed)
{exp:sso:email_error}
(Added in v.3.0.0)
This hook is triggered when the user hits the callback url
if (ee()->extensions->active_hook('sso_callback') === TRUE)
{
ee()->extensions->call('sso_callback');
}
(Added in v.3.0.0) This hook is triggered when a user is logged in via a social provider
if (ee()->extensions->active_hook('sso_login') === TRUE)
{
ee()->extensions->call('sso_login', $memberObject, $isNewUser);
}
(Added in v.3.0.0) This hook is triggered when a user connect an existing account to the current logged in account
if (ee()->extensions->active_hook('sso_connect') === TRUE)
{
ee()->extensions->call('sso_connect', $providerName);
}
{exp:sso:email_error}
tag in the collect email tag{exp:sso:auth_error}
tag for general auth errors{exp:sso:linked_providers}
for connect multiple providers to one account{exp:sso:login_error}
tag (use {exp:sso:auth_error}
)v2.12.0
no_email_return=""
param that is used when there is no mail available from the social loginnew_member_return=""
when the user is new*Note: you need to add your license key and license email from addons.reinos.nl in order to validate your license and add a valid domain url in your license field on addons.reinos.nl/profile/licenses or the module will not work on a live site. Also make sure you have read the license section in the documentation
&
is already encoded