Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-16 20:26:19 -05:00
Code Issues Activity
logto/packages/connectors/connector-gitlab
History
Charles Zhao baef49df3c
chore: bump dependencies (#6873) 
* chore: bump dependencies

* fix: ui test

* fix: ui test
2024-12-11 17:35:47 +08:00
..
src feat: add GitLab connector (#6529) 2024-09-02 16:44:45 +08:00
CHANGELOG.md release: version packages (#6424) 2024-09-13 18:06:50 +08:00
logo.svg feat: add GitLab connector (#6529) 2024-09-02 16:44:45 +08:00
package.json chore: bump dependencies (#6873) 2024-12-11 17:35:47 +08:00
README.md feat: add GitLab connector (#6529) 2024-09-02 16:44:45 +08:00

README.md

GitLab Connector

The official Logto connector for GitLab social sign-in, based on the Hugging Face connector by Silverhand Inc.

Table of contents

Get started

The GitLab connector enables end-users to sign in to your application using their own GitLab accounts via the GitLab OAuth 2.0 authentication protocol.

Sign in with GitLab account

Go to the GitLab website and sign in with your GitLab account. You may register a new account if you don't have one.

Create and configure OAuth app

Follow the creating a GitLab OAuth App guide, and register a new application.

Name your new OAuth application in Name and fill up Redirect URI of the app. Customize the Redirect URIs as ${your_logto_origin}/callback/${connector_id}. The connector_id can be found on the top bar of the Logto Admin Console connector details page.

On scopes, select openid. You also may want to enable profile, and email. profile scope is required to get the user's profile information, and email scope is required to get the user's email address. Ensure you have allowed these scopes in your GitLab OAuth app if you want to use them.

Notes:

  • If you use custom domains, add both the custom domain and the default Logto domain to the Redirect URIs to ensure the OAuth flow works correctly with both domains.
  • If you encounter the error message "The redirect_uri MUST match the registered callback URL for this application." when logging in, try aligning the Redirect URI of your GitLab OAuth App and your Logto App's redirect URL (including the protocol) to resolve the issue.

Managing OAuth apps

Go to the Applications page on GitLab, where you can add, edit, or delete existing OAuth apps. You can also find the Application ID and generate Secret in the OAuth app detail pages.

Configure your connector

Fill out the clientId and clientSecret field with the Application ID and Secret you've got from the OAuth app detail pages mentioned in the previous section.

scope is a space-delimited list of scopes. If not provided, scope defaults to be openid. For GitLab connector, the scope you may want to use are openid, profile and email. profile scope is required to get the user's profile information, and email scope is required to get the user's email address. Ensure you have allowed these scopes in your GitLab OAuth app (configured in Create an OAuth app in the Hugging Face section).

Config types

Name Type
clientId string
clientSecret string
scope string

Test GitLab connector

That's it. The GitLab connector should be available now. Don't forget to Enable connector in sign-in experience.

Reference