For our new friends:

Logto is an Auth0 alternative designed for modern apps and SaaS products. It offers both Cloud and Open-source services to help you quickly launch your identity and management (IAM) system. Enjoy authentication, authorization, and multi-tenant management all in one.

We recommend starting with a free development tenant on Logto Cloud. This allows you to explore all the features easily.

In this article, we will go through the steps to quickly build the OAuth2 sign-in experience (user authentication) with WordPress plugin and Logto.

Prerequisites

• A running Logto instance. Check out the introduction page to get started.
• Basic knowledge of WordPress plugin.
• A usable OAuth2 account.

Create an application in Logto

Logto is based on OpenID Connect (OIDC) authentication and OAuth 2.0 authorization. It supports federated identity management across multiple applications, commonly called Single Sign-On (SSO).

To create your Traditional web application, simply follow these steps:

1. Open the Logto Console. In the "Get started" section, click the "View all" link to open the application frameworks list. Alternatively, you can navigate to Logto Console > Applications, and click the "Create application" button.
2. In the opening modal, click the "Traditional web" section or filter all the available "Traditional web" frameworks using the quick filter checkboxes on the left. Click the "WordPress" framework card to start creating your application.
3. Enter the application name, e.g., "Bookstore," and click "Create application".

🎉 Ta-da! You just created your first application in Logto. You'll see a congrats page which includes a detailed integration guide. Follow the guide to see what the experience will be in your application.

Integrate WordPress with Logto

Install the plugin

From WordPress admin panel

1. Go to Plugins > Add New.
2. Search for "Logto", or enter https://wordpress.org/plugins/logto/ in the search box.
3. Click Install Now.
4. Click Activate.

From upload

1. Download the Logto WordPress plugin from one of the following links:
   • Latest release: Download the file which name in the format of logto-plugin-<version>.zip.
   • WordPress plugin directory: Download the file by clicking the Download button.
2. Download the plugin ZIP file.
3. Go to Plugins > Add New in your WordPress admin panel.
4. Click Upload Plugin.
5. Select the downloaded ZIP file and click Install Now.
6. Click Activate.

Configure the plugin

Now you should be able to see the Logto menu in your WordPress admin panel sidebar. Click Logto > Settings to configure the plugin.

note:

You should have a traditional web application created in Logto Console before configuring the plugin. If you haven't created one, please refer to Integrate Logto into your application for more information.

The minimum configuration to get started for the plugin is:

• Logto endpoint: The endpoint of your Logto tenant.
• App ID: The app ID of your Logto application.
• App secret: One of the valid app secrets of your Logto application.

All values can be found on the application details page in Logto Console.

After filling in the values, click Save Changes (scroll down to the bottom of the page if you can't find the button).

Configure redirect URI

The redirect URI is the URL to which Logto will redirect users after they have authenticated; and the post sign-out redirect URI is the URL to which Logto will redirect users after they have logged out.

Here's a non-normative sequence diagram to illustrate the sign-in flow:

Here's how the sign-out flow looks like in a non-normative sequence diagram:

To learn more about why redirect is needed, see Sign-in experience explained.

In our case, we need to configure both redirect URIs in your Logto Console. To find the redirect URI, go to the Logto > Settings page in your WordPress admin panel. You'll see the Redirect URI and Post sign-out redirect URI fields.

1. Copy the Redirect URI and Post sign-out redirect URI values and paste them into the Redirect URIs and Post sign-out redirect URIs fields in your Logto Console.
2. Click Save changes in Logto Console.

Checkpoint: Test your WordPress website

Now you can test your Logto integration in your WordPress website:

1. Open an incognito browser window if needed.
2. Visit your WordPress website and click the Log in link if applicable; or directly visit the login page (e.g., https://example.com/wp-login.php).
3. The page should redirect you to the Logto sign-in page.
4. Complete the sign-in or sign-up process.
5. After successful authentication, you should be redirected back to your WordPress website and logged in automatically.
6. Click the Log out link to log out of your WordPress website.
7. You should be redirected to the Logto sign-out page, then back to your WordPress website.
8. You should be logged out of your WordPress website.

To learn more about the WordPress plugin settings, see WordPress quick start.

Add OAuth2 connector

To enable quick sign-in and improve user conversion, connect with WordPress as an identity provider. The Logto social connector helps you establish this connection in minutes by allowing several parameter inputs.

To add a social connector, simply follow these steps:

1. Navigate to Console > Connectors > Social Connectors.
2. Click "Add social connector" and select "OAuth2".
3. Follow the README guide and complete required fields and customize settings.

note:

If you are following the in-place Connector guide, you can skip the next section.

Set up Standard OAuth 2.0 app

Create your OAuth app

When you open this page, we believe you already know which social identity provider you want to connect to. The first thing to do is to confirm that the identity provider supports the OAuth protocol, which is a prerequisite for configuring a valid connector. Then, follow the identity provider's instructions to register and create the relevant app for OAuth authorization.

Configure your connector

We ONLY support "Authorization Code" grant type for security consideration and it can perfectly fit Logto's scenario.

clientId and clientSecret can be found at your OAuth apps details page.

clientId: The client ID is a unique identifier that identifies the client application during registration with the authorization server. This ID is used by the authorization server to verify the identity of the client application and to associate any authorized access tokens with that specific client application.

clientSecret: The client secret is a confidential key that is issued to the client application by the authorization server during registration. The client application uses this secret key to authenticate itself with the authorization server when requesting access tokens. The client secret is considered confidential information and should be kept secure at all times.

tokenEndpointAuthMethod: The token endpoint authentication method is used by the client application to authenticate itself with the authorization server when requesting access tokens. To discover supported methods, consult the token_endpoint_auth_methods_supported field available at the OAuth 2.0 service provider’s OpenID Connect discovery endpoint, or refer to the relevant documentation provided by the OAuth 2.0 service provider.

clientSecretJwtSigningAlgorithm (Optional): Only required when tokenEndpointAuthMethod is client_secret_jwt. The client secret JWT signing algorithm is used by the client application to sign the JWT that is sent to the authorization server during the token request.

scope: The scope parameter is used to specify the set of resources and permissions that the client application is requesting access to. The scope parameter is typically defined as a space-separated list of values that represent specific permissions. For example, a scope value of "read write" might indicate that the client application is requesting read and write access to a user's data.

You are expected to find authorizationEndpoint, tokenEndpoint and userInfoEndpoint in social vendor's documentation.

authenticationEndpoint: This endpoint is used to initiate the authentication process. The authentication process typically involves the user logging in and granting authorization for the client application to access their resources.

tokenEndpoint: This endpoint is used by the client application to obtain an access token that can be used to access the requested resources. The client application typically sends a request to the token endpoint with a grant type and authorization code to receive an access token.

userInfoEndpoint: This endpoint is used by the client application to obtain additional information about the user, such as their fullname, email address or profile picture. The user info endpoint is typically accessed after the client application has obtained an access token from the token endpoint.

Logto also provide a profileMap field that users can customize the mapping from the social vendors' profiles which are usually not standard. The keys are Logto's standard user profile field names and corresponding values should be social profiles' field names. In current stage, Logto only concern 'id', 'name', 'avatar', 'email' and 'phone' from social profile, only 'id' is required and others are optional fields.

responseType and grantType can ONLY be FIXED values with authorization code grant type, so we make them optional and default values will be automatically filled.

For example, you can find Google user profile response and hence its profileMap should be like:

{
  "id": "sub",
  "avatar": "picture"
}

note:

We provided an OPTIONAL customConfig key to put your customize parameters. Each social identity provider could have their own variant on OAuth standard protocol. If your desired social identity provider strictly stick to OAuth standard protocol, the you do not need to care about customConfig.

Config types

Name	Type	Required
authorizationEndpoint	string	true
userInfoEndpoint	string	true
clientId	string	true
clientSecret	string	true
tokenEndpointResponseType	enum	false
responseType	string	false
grantType	string	false
tokenEndpoint	string	false
scope	string	false
customConfig	Record<string, string>	false
profileMap	ProfileMap	false

ProfileMap fields	Type	Required	Default value
id	string	false	id
name	string	false	name
avatar	string	false	avatar
email	string	false	email
phone	string	false	phone

General settings

Here are some general settings that won't block the connection to your identity provider but may affect the end-user authentication experience.

Social button name and logo

If you want to display a social button on your login page, you can set the name and logo (dark mode and light mode) of the social identity provider. This will help users recognize the social login option.

Identity provider name

Each social connector has a unique Identity Provider (IdP) name to differentiate user identities. While common connectors use a fixed IdP name, custom connectors require a unique value. Learn more about IdP names for more details.

Sync profile information

In the OAuth connector, you can set the policy for syncing profile information, such as user names and avatars. Choose from:

• Only sync at sign-up: Profile info is fetched once when the user first signs in.
• Always sync at sign-in: Profile info is updated every time the user signs in.

Store tokens to access third-party APIs (Optional)

If you want to access the Identity Provider's APIs and perform actions with user authorization (whether via social sign-in or account linking), Logto needs to get specific API scopes and store tokens.

1. Add the required scopes in the scope field following the instructions above
2. Enable Store tokens for persistent API access in the Logto OAuth connector. Logto will securely store access tokens in the Secret Vault.
3. For standard OAuth/OIDC identity providers, the offline_access scope must be included to obtain a refresh token, preventing repeated user consent prompts.

warning:

Keep your client secret secure and never expose it in client-side code. If compromised, generate a new one immediately in your identity provider's app settings.

Utilize the OAuth connector

Once you've created an OAuth connector and connected it to your identity provider, you can incorporate it into your end-user flows. Choose the options that match your needs:

Enable social sign-in button

1. In Logto Console, go to Sign-in experience > Sign-up and sign-in.
2. Add the OAuth connector under Social sign-in section to let users authenticate with your identity provider.

Learn more about social sign-in experience.

Link or unlink a social account

Use the Account API to build a custom Account Center in your app that lets signed-in users link or unlink their social accounts. Follow the Account API tutorial

tip:

It's allowed to enable the OAuth connector only for account linking and API access, without enabling it for social sign-in.

Access identity provider APIs and perform actions

Your application can retrieve stored access tokens from the Secret Vault to call your identity provider's APIs and automate backend tasks. The specific capabilities depend on your identity provider and the scopes you've requested. Refer to the guide on retrieving stored tokens for API access.

Manage user's social identity

After a user links their social account, admins can manage that connection in the Logto Console:

1. Navigate to Logto console > User management and open the user's profile.
2. Under Social connections, locate the identity provider item and click Manage.
3. On this page, admins can manage the user's social connection, see all profile information granted and synced from their social account, and check the access token status.

note:

A few Identity Provider access token response does not include the specific scope information, so Logto cannot directly display the list of permissions granted by the user. However, as long as the user has consented to the requested scopes during authorization, your application will have the corresponding permissions when accessing the OAuth API.

Save your configuration

Double check you have filled out necessary values in the Logto connector configuration area. Click "Save and Done" (or "Save changes") and the OAuth2 connector should be available now.

Enable OAuth2 connector in Sign-in Experience

Once you create a social connector successfully, you can enable it as a "Continue with OAuth2" button in Sign-in Experience.

1. Navigate to Console > Sign-in experience > Sign-up and sign-in.
2. (Optional) Choose "Not applicable" for sign-up identifier if you need social login only.
3. Add configured OAuth2 connector to the "Social sign-in" section.

Testing and Validation

Return to your WordPress plugin app. You should now be able to sign in with OAuth2. Enjoy!

Further readings

End-user flows: Logto provides a out-of-the-box authentication flows including MFA and enterprise SSO, along with powerful APIs for flexible implementation of account settings, security verification, and multi-tenant experience.

Authorization: Authorization defines the actions a user can do or resources they can access after being authenticated. Explore how to protect your API for native and single-page applications and implement Role-based Access Control (RBAC).

Organizations: Particularly effective in multi-tenant SaaS and B2B apps, the organization feature enable tenant creation, member management, organization-level RBAC, and just-in-time-provisioning.

Customer IAM series Our serial blog posts about Customer (or Consumer) Identity and Access Management, from 101 to advanced topics and beyond.