BP Login and SSO

8 min read

Admin
Portal
Day
0
System
Settings


BP Login & SSO #

In addition
to the standard email and password login, BuildPiper supports several Single
Sign-On (SSO)
and social authentication providers to streamline access and maintain security.

SSO configuration is
centralised within the System Settings dashboard and is accessible
exclusively via Admin credentials.

7
Auth Methods

SSO
Enterprise

OAuth2
Supported

Admin
Only Setup

Supported
SSO & Social Login Providers #

BP SSO โ€”
Login Method Matrix #

BP
SSO
All Supported Login Methods

Social Login

๐Ÿ”ตGoogle

๐ŸชŸMicrosoft


Enterprise Login

๐Ÿ”OKTA

๐Ÿ—‚๏ธLDAP


Git Login

๐ŸชฃBitbucket

๐ŸฆŠGitLab

๐Ÿ™GitHub


Standard

โœ‰๏ธEmail & Password

Important
Note on SSO Configuration #

๐Ÿ“Œ

  • BuildPiper offers a seamless, plug-and-play SSO
    configuration
    for standard providers like Okta, LDAP, and major Git platforms.
  • If your organisation uses a unique or non-standard authentication stack, BP’s extensible
    architecture allows your team to easily integrate it via custom step
    configuration
    โ€” ensuring complete flexibility without being restricted by
    out-of-the-box plugins.

Configuring SSO #

BuildPiper SSO Setup (Day 0)
supports major enterprise SSO and social authentication. Configuration is centralised within the System Settings dashboard and is accessible exclusively via Admin
credentials.


Navigation
Path
How to Access System Settings

Login to BP

โ†’


Bottom User Panel

โ†’


System Settings


๐Ÿ”’ Admin credentials are required. Only
Super Admin users can access and configure SSO settings.

โ„น๏ธ

SOP Reference
Note

Refer to SSO – Google
Configuration (page 39)
of the SOP document for detailed setup steps.

The SPOC installing BP on the client’s end must update the env.json with the relevant configuration once SSO is enabled.

Google OAuth2.0
Configuration #

To use Google OAuth2.0 you need to
create a Client ID and Secret from your Google OAuth2.0 provider, then
configure the values in BuildPiper System Settings.

Google OAuth2.0 โ€” System Settings Fields
Admin โ†’ System Settings โ†’ Google OAuth2.0

Field
Google
OAuth2.0 Client Key*
Your Google
OAuth2.0 Client ID used for authentication.
Google
OAuth2.0 Secret Key*
The Google
OAuth2.0 Secret Key used for authentication.
Redirect
URI of Frontend App*
Example: https://app.buildpiper.io/auth/complete/google
Redirect
State of Google OAuth2.0*
Set to false
unless your setup requires state validation.

Google OAuth2.0 System Settings
Google OAuth2.0 System Settings

โœ…

After saving
System Settings:
Update the SSO URL for
Google in runtime-env.js
(non-root setup) or env.json
(root setup). The Google SSO Link URL must include the Client ID unique to each
client
.


AD
Authentication Configuration #

Configure Active Directory (LDAP)
authentication within BuildPiper System Settings to enable enterprise identity management.

๐Ÿ—‚๏ธ

AD Authentication โ€” System Settings Fields
Admin โ†’ System Settings โ†’ AD Authentication


Configuration
Description

Do you want to manage permissions using BP
Enables BuildPiper
to manage user roles and permissions internally instead of relying on external identity
providers.

Do you want to enable AD Authentication
Enables
authentication via Active Directory (AD) using LDAP-based directory services.

LDAP server URI where LDAP is hosted
Specifies the LDAP
server endpoint used to connect for directory-based authentication.

LDAP Manager distinguished name
Defines the admin
user DN used by BP to authenticate and query the LDAP directory.

LDAP Manager password
Password for the
LDAP manager DN used to securely access the directory.

LDAP search base
Base DN from where
BP searches for user records in the LDAP directory.

LDAP user search filter
LDAP query filter
used to locate users based on attributes such as username.

LDAP group search base
Base DN from where
BP searches for group information in LDAP.

LDAP Group Memberships filter
LDAP filter used
to identify group memberships associated with users.

LDAP Roles mapping
Defines mapping
between LDAP groups and BP roles for role-based access control.

GitHub
OAuth2.0 Configuration #

Configure GitHub OAuth2.0 within
BuildPiper System Settings. Generate a Client ID and Secret from GitHub
Developer Settings and fill in the required fields below.

๐Ÿ™

GitHub OAuth2.0 โ€” System Settings Fields
Admin โ†’ System Settings โ†’ GitHub OAuth2.0


Configuration
Description

GitHub OAuth2.0 Client ID
Unique client identifier generated from GitHub
Developer Settings used to identify the application during OAuth authentication.

GitHub OAuth2.0 Client Secret
Confidential secret key associated with the client
ID used to securely validate the authentication flow.

Redirect URI of Frontend Application
Callback URL where GitHub redirects the user after
successful authentication.

Authorization URL of GitHub OAuth2.0
GitHub endpoint used to initiate user login and
consent during OAuth authentication.

Access Token URL of GitHub OAuth2.0
Endpoint used to exchange the authorization code
for an OAuth access token.

Access Token Request Method of GitHub OAuth2.0
HTTP method (typically POST)
used to securely request the access token from GitHub.

GitHub REST API URL
Base API endpoint used by BP to fetch authenticated
user details and related information from GitHub.

GitLab OAuth2.0
Configuration #

Configure GitLab OAuth2.0 within
BuildPiper System Settings. The following fields and environment variables are required.

๐ŸฆŠ

GitLab OAuth2.0 โ€” System Settings Fields
Admin โ†’ System Settings โ†’ GitLab


Field Label

Env Variable
Example Value

GitLab OAuth2.0 Client ID
SOCIAL_AUTH_GITLAB_KEY fa33aaf1d2df9dca10fb129cd6xxxโ€ฆ

GitLab OAuth2.0 Secret ID
SOCIAL_AUTH_GITLAB_SECRET 752f1b02b8a92abd9477xxxโ€ฆ

Redirect URI of Frontend App
SOCIAL_AUTH_GITLAB_REDIRECT_URI https://buildpiper.xxxx.com/auth/complete/gitlab

Authorization URL
SOCIAL_AUTH_GITLAB_AUTHORIZATION_URL https://buildpiper.xxxx.com/auth/complete/gitlab

Access Token URL
SOCIAL_AUTH_GITLAB_ACCESS_TOKEN_URL http://gitlab.xxxxx.net/oauth/token

Access Token Request Method
SOCIAL_AUTH_GITLAB_ACCESS_TOKEN_METHOD POST

GitLab REST API URL
SOCIAL_AUTH_GITLAB_API_URL http://gitlab.lenskartserver.net

Bitbucket
OAuth2.0 Configuration #

Configure Bitbucket OAuth2.0 within
BuildPiper System Settings. Generate your credentials from Bitbucket Developer settings and fill in the fields
below.

๐Ÿชฃ

Bitbucket OAuth2.0 โ€” System Settings Fields
Admin โ†’ System Settings โ†’ Bitbucket OAuth2.0


Configuration
Description

Bitbucket OAuth2.0 Client ID
Unique client identifier generated from Bitbucket
Developer settings used to identify the application during OAuth authentication.

Bitbucket OAuth2.0 Secret ID
Confidential secret key associated with the client
ID used to securely validate the OAuth authentication flow.

Redirect URI of Frontend Application
Callback URL where Bitbucket redirects the user
after successful authentication.

Authorization URL of Bitbucket OAuth2.0
Bitbucket endpoint used to initiate user login and
consent for OAuth authentication.

Access Token URL of Bitbucket OAuth2.0
Endpoint used to exchange the authorization code
for an OAuth access token.

Access Token Request Method of Bitbucket OAuth2.0
HTTP method (typically POST)
used to securely request the access token from Bitbucket.

Bitbucket User Unique ID
Attribute used to uniquely identify the
authenticated user within Bitbucket.

Bitbucket Default Scope of Logged User
Defines the default permission scope granted to the
application for accessing Bitbucket user resources.

Microsoft
OAuth2.0 Configuration #

Configure Microsoft OAuth2.0 within
BuildPiper System Settings. Credentials are generated from Microsoft Azure App
Registration
.

๐ŸชŸ

Microsoft OAuth2.0 โ€” System Settings Fields
Admin โ†’ System Settings โ†’ Microsoft OAuth2.0


Configuration
Description

Microsoft OAuth2.0 Client ID
Unique client identifier generated from Microsoft
Azure App Registration used to identify the application during OAuth authentication.

Microsoft OAuth2.0 Secret Key
Confidential secret key associated with the client
ID used to securely validate the OAuth authentication flow.

Redirect URI of Frontend Application
Callback URL where Microsoft redirects the user
after successful authentication.

Redirect State of Microsoft OAuth2.0
Parameter used to maintain request state and
prevent CSRF attacks during the OAuth authentication process.

Authorization URL of Microsoft OAuth2.0
Microsoft endpoint used to initiate user login and
consent for OAuth authentication.

Access Token URL of Microsoft OAuth2.0
Endpoint used to exchange the authorization code
for an OAuth access token.

Access Token Request Method of Microsoft OAuth2.0
HTTP method (typically POST)
used to securely request the access token from Microsoft.

Microsoft Default Scope of Logged User
Defines the default permission scope granted to
access Microsoft user profile and related resources.

OKTA
Configuration #

Configure OKTA SSO within BuildPiper
System Settings. Credentials are generated from the Okta application
dashboard
. OKTA also supports PKCE for enhanced public client security.

๐Ÿ”

OKTA โ€” System Settings Fields
Admin โ†’ System Settings โ†’ OKTA


Configuration
Description

Redirect URI of Frontend Application for MI
Callback URL used for Microsoft Identity-based
redirection after successful Okta authentication.

Okta Client ID
Unique client identifier generated in the Okta
application used to identify BP during OAuth authentication.

Okta Secret Key
Confidential secret key linked with the Okta client
ID used to securely validate authentication requests.

Redirect URI of Frontend Application
URL where Okta redirects the user after successful
login and authorization.

Redirect State of OKTA
Parameter used to maintain request state and
prevent CSRF attacks during authentication.

Access Token URL of OKTA
Endpoint used to exchange the authorization code
for an OAuth access token from Okta.

Access Token Request Method of OKTA
HTTP method (typically POST)
used to securely request the access token.

Okta User Info URL
API endpoint used to retrieve authenticated user
profile details from Okta.

User Info Okta URL Method
HTTP method used to fetch user information from the
Okta user info endpoint.

User can use functionality of OKTA PKCE
Enables PKCE (Proof Key for Code Exchange) to
enhance security for public clients during OAuth authentication.

๐Ÿ“˜ BuildPiper
Documentation
ยท BP Login & SSO

Last updated: March 2026