You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Lightweight Directory Access Protocol (LDAP) is a vendor-neutral software protocol used to lookup information or devices within a network. Bytebase supports using LDAP for configuring Single Sign-On (SSO).
@@ -8,25 +9,25 @@ Lightweight Directory Access Protocol (LDAP) is a vendor-neutral software protoc
8
9
9
10
Basic information:
10
11
11
-
***Name**: the display name shown to your users (e.g. `JumpCloud`)
12
-
***Identity Provider ID**: a human-readable unique string, only lower-case alphabets and hyphens are allowed (e.g. `jumpcloud`)
13
-
***Domain**: the domain name to scope associated users (e.g. `jumpcloud.com`, optional)
12
+
-**Name**: the display name shown to your users (e.g. `JumpCloud`)
13
+
-**Identity Provider ID**: a human-readable unique string, only lower-case alphabets and hyphens are allowed (e.g. `jumpcloud`)
14
+
-**Domain**: the domain name to scope associated users (e.g. `jumpcloud.com`, optional)
14
15
15
16
Identity provider information:
16
17
17
-
***Host**: the host of LDAP server (e.g. `ldap.jumpcloud.com`)
18
-
***Port**: the port number of the LDAP server, usually 389 for StartTLS and 636 for LDAPS
19
-
***Bind DN**: the Distinguished Name (DN) of the user to bind as a service account to perform search requests (e.g. `uid=system,ou=Users,dc=jumpcloud,dc=com`)
20
-
***Bind Password**: the password of the user to bind as a service account
21
-
***Base DN**: the base Distinguished Name (DN) to search for users (e.g. `ou=users,dc=jumpcloud,dc=com`)
22
-
***User Filter**: the filter to search for users (e.g. `(uid=%s)`, where `%s` will be subsituted by the username)
23
-
***Security protocol**: the security protocol to be used for establishing connections with the LDAP server
18
+
-**Host**: the host of LDAP server (e.g. `ldap.jumpcloud.com`)
19
+
-**Port**: the port number of the LDAP server, usually 389 for StartTLS and 636 for LDAPS
20
+
-**Bind DN**: the Distinguished Name (DN) of the user to bind as a service account to perform search requests (e.g. `uid=system,ou=Users,dc=jumpcloud,dc=com`)
21
+
-**Bind Password**: the password of the user to bind as a service account
22
+
-**Base DN**: the base Distinguished Name (DN) to search for users (e.g. `ou=users,dc=jumpcloud,dc=com`)
23
+
-**User Filter**: the filter to search for users (e.g. `(uid=%s)`, where `%s` will be subsituted by the username)
24
+
-**Security protocol**: the security protocol to be used for establishing connections with the LDAP server
24
25
25
26
User information field mapping:
26
27
27
-
***Email**: the attribute to be used as the Bytebase user email address (e.g. `mail`)
28
-
***Display name**: the attribute to be used as the Bytebase user display name (e.g. `displayName`, optional)
29
-
***Phone**: the attribute to be used as the Bytebase user phone number (e.g. `phone`, optional)
28
+
-**Email**: the attribute to be used as the Bytebase user email address (e.g. `mail`)
29
+
-**Display name**: the attribute to be used as the Bytebase user display name (e.g. `displayName`, optional)
30
+
-**Phone**: the attribute to be used as the Bytebase user phone number (e.g. `phone`, optional)
30
31
31
32
### JumpCloud
32
33
@@ -73,4 +74,3 @@ The attribute `uid` is the username (e.g. `system`) not the email (e.g. `system@
Copy file name to clipboardExpand all lines: content/docs/administration/sso/oauth2.md
+19-11Lines changed: 19 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,8 +60,23 @@ If you start Bytebase with `--external-url http://bytebase.example.com`, then th
60
60
61
61
Bytebase provides templates for configuring built-in OAuth providers.
62
62
63
+
### Google
64
+
65
+
<PricingPlanBlockfeature_name='SSO_BASIC' />
66
+
67
+
1. Follow the [Using OAuth 2.0 to Access Google APIs](https://developers.google.com/identity/protocols/oauth2) to create OAuth 2.0 client credentials in [Google API Console](https://console.developers.google.com/).
2. Open creating SSO dialog and select the **Google** template.
72
+
3. Update the **Client ID** and **Client secret** fields with the OAuth 2.0 client credential you just created.
73
+
4. After filling in all the required fields, try to click **Test connection**.
74
+
5. If everything is OK, click the **Create** button.
75
+
63
76
### GitHub
64
77
78
+
<PricingPlanBlockfeature_name='SSO_BASIC' />
79
+
65
80
1. Follow [Creating an OAuth App in GitHub](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) to create an OAuth app in GitHub.
1. Follow [Configure GitLab as an OAuth 2.0 authentication identity provider](https://docs.gitlab.com/ee/integration/oauth_provider.html) to create an OAuth 2 application in GitLab.
4. After filling in all the required fields, try to click **Test connection**.
83
100
5. If everything is OK, click the **Create** button.
84
101
85
-
### Google
86
-
87
-
1. Follow the [Using OAuth 2.0 to Access Google APIs](https://developers.google.com/identity/protocols/oauth2) to create OAuth 2.0 client credentials in [Google API Console](https://console.developers.google.com/).
2. Open creating SSO dialog and select the **Google** template.
92
-
3. Update the **Client ID** and **Client secret** fields with the OAuth 2.0 client credential you just created.
93
-
4. After filling in all the required fields, try to click **Test connection**.
94
-
5. If everything is OK, click the **Create** button.
95
-
96
102
### Microsoft Entra (Azure AD)
97
103
104
+
<PricingPlanBlockfeature_name='SSO_ADVANCED' />
105
+
98
106
1. Follow the [Register an application with the Microsoft identity platform](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app) to create an Application in [Microsoft Entra admin center](https://entra.microsoft.com/).
Copy file name to clipboardExpand all lines: content/docs/administration/sso/overview.md
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,5 @@
1
1
---
2
2
title: Single Sign-On (SSO)
3
-
feature_name: SSO
4
3
---
5
4
6
5
Single Sign-On (SSO) is an authentication method that enables users to securely authenticate with multiple applications and websites by using just one set of credentials.
0 commit comments