In this section · 4 articles

Social Login providers, settings and permissions

Every provider Social Login offers, with its key, credentials and what it supports. Also the provider form and list, deleting and restoring providers, the related settings, and the permissions.

Applies to
Social Login 2.0 and later
Who can do this
Platform owner, Administrator
Where
Social Login (Platform Administration)
On this page

The providers

The Provider Key is part of the callback address, https://<your Laramin's address>/auth/<key>/callback.

ProviderProvider KeyCredentialsVouches for the email addressFrom a mobile app
GooglegoogleClient ID, Client Secret, iOS Client ID, Android Client IDYesPhone's browser, or Google's own sign-in
AppleappleClient ID, Team ID, Key ID, Private Key (.p8), iOS Client IDYesPhone's browser, or Apple's own sign-in
FacebookfacebookClient ID, Client SecretNoPhone's browser
GitHubgithubClient ID, Client SecretYesPhone's browser
GitLabgitlabClient ID, Client SecretYesPhone's browser
BitbucketbitbucketClient ID, Client SecretYesPhone's browser
LinkedIn (OpenID Connect)linkedin-openidClient ID, Client SecretYesPhone's browser
LinkedInlinkedinClient ID, Client SecretYesPhone's browser
Slack (OpenID Connect)slack-openidClient ID, Client SecretYesPhone's browser
SlackslackClient ID, Client SecretYesPhone's browser
TwitchtwitchClient ID, Client SecretYesPhone's browser
XxClient ID, Client SecretNoPhone's browser
Twitter (OAuth 2)twitter-oauth-2Client ID, Client SecretNoPhone's browser
Twitter (OAuth 1.0a)twitterConsumer Key, Consumer SecretYesNot supported

Every provider except Twitter (OAuth 1.0a) also has Scopes: leave it empty for the standard set, which asks for the person's basic profile and email address.

  • Vouches for the email address: whether a sign-in may be linked to an existing account with the same email address, and whether a new account's address counts as verified. See How social sign-in works.
  • Google, Facebook and LinkedIn are on the list from the start, Inactive, under the keys Google, Facebook and Linkedin.
  • If Apple isn't offered under Provider Key, ask whoever runs your server to install the socialiteproviders/apple package.

The provider form

Social Login › Social Login Providers, then a row's Edit.

TabFieldWhat it does
Provider DetailsLogoThe image on the sign-in button. Required.
Provider DetailsProvider KeyThe provider. Can't be changed after the provider is added, because linked accounts and the callback address depend on it.
Provider DetailsDisplay NameThe text on the sign-in button. Empty shows the Provider Key. Up to 100 characters.
Provider DetailsStatusActive shows the button once every required credential is filled in. Inactive hides it and refuses sign-ins with this provider. A provider is always added Inactive.
Provider DetailsCredentialsThe provider's own fields, from the table above. Secrets are never shown again after saving: leave a secret empty to keep it.
How to Config?Setup steps for the provider, read-only.
The Edit Social Login Providers drawer for Google on the Provider Details tab, showing Logo, Provider Key, Display Name, Status and the Client ID and Client Secret credentials, with the How to Config? tab beside it.

When you add a provider with New Social Login Provider, the form only asks for the Provider Key. Everything else is filled in from the provider, and you complete it with Edit.

The Create Social Login Providers drawer with the Add a provider note and the highlighted Provider Key field open, listing providers such as Apple, Bitbucket, GitLab and Slack.

The list

ColumnWhat it shows
Provider KeyThe provider. Opens the provider.
StatusActive or Inactive. Filterable.
ReadinessReady: active and complete, so its button shows. Incomplete: a required credential is missing. Needs attention: the provider's code isn't installed on this Laramin, so it can't sign anyone in. The form then shows Driver unavailable, and keeps the stored credentials.
Client IDThe last four characters of the client ID, or Not configured. Exports to CSV show the same.
The Social Login Providers list showing the Provider Key, Status, Readiness and Client ID columns, with Google Active and Ready, and Linkedin Inactive and Incomplete with Client ID Not configured.

Deleting and restoring

  • Delete moves a provider to the trash. Its button disappears and its sign-ins stop. Accounts linked to it stay linked.
  • Restore brings it back from the trash, with its credentials.
  • Delete forever removes it with its credentials, after you type its Provider Key to confirm. It isn't offered while any account signs in with that provider, and the server refuses it too: "Google cannot be permanently removed: 3 account(s) sign in with it."

A provider in the trash isn't offered under New Social Login Provider. Restore it instead.

SettingWhereEffect
Allow public registrationConfigurations › Security › Security SettingsLets a first social sign-in from the website or admin create an account. Off to start with.
Allow mobile app sign-upConfigurations › Security › Security SettingsLets a first social sign-in from your mobile app create an account. Off to start with.

Whoever runs your server can also set credentials in the server's configuration, as services.<key>.client_id and so on. A value there is used when the matching field is empty. The mobile settings are in Social sign-in from a mobile app.

Permissions

In the role editor, they're under Social Login.

PermissionLabelAllows
feature.social.provider.listList ProviderOpening Social Login and its list.
feature.social.provider.viewView ProviderOpening a provider.
feature.social.provider.createCreate ProviderNew Social Login Provider.
feature.social.provider.editEdit ProviderChanging credentials, the logo, the display name and the status.
feature.social.provider.deleteDelete ProviderMoving providers to the trash.
feature.social.provider.restoreRestore ProviderBringing them back.
feature.social.provider.removeRemove ProviderDeleting them permanently.

Careful: Edit Provider decides who can sign in to your Laramin and through which outside accounts. Give it only to people you'd trust with your sign-in page.

To give these permissions, see Give someone a role.