Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@ On the **Profile settings** page, you can:
1. Select the **Account settings** option.

![account-settings-page.png](/img/_paligo/uuid-b08c42b9-affd-b40d-3c6e-87410001d2fb.png)
1. Find the **Account details** section, and click **Edit**.
1. Enter your current password when prompted, and click **Done**.
1. To change your username, type in the new username in the **Username** field.
1. To change your email, type in a new email address in the **Email** field.
1. To change your password, type in a new password in the **Password** field, and then type it again in the **Confirm password** field.
1. When done, click **Update**.
1. To change your password, type in a new password in the **New password** field, and then type it again in the **Confirm new password** field.
1. When done, click **Confirm changes**.


## Adding an avatar to your account
Expand All @@ -38,9 +40,9 @@ You can add your own personalized avatar to your Bitrise account.
1. Select the **Account settings** option.

![account-settings-page.png](/img/_paligo/uuid-b08c42b9-affd-b40d-3c6e-87410001d2fb.png)
1. Find your default avatar on the left, above the account name.
1. Click the image.
1. Drag and drop your new avatar in the **CHANGE AVATAR** window, or click **Browse** to choose an image from your computer.
1. Scroll down to your avatar below the **Account details** section, and click **Edit**.
1. In the **Change avatar** dialog, drag and drop your new avatar, or select a file from your computer.
1. Click **Save changes**.


## Unselecting notification preferences
Expand Down
4 changes: 2 additions & 2 deletions docs/bitrise-platform/accounts/personal-access-tokens.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To create a new personal access token:
![account-settings-page.png](/img/_paligo/uuid-b08c42b9-affd-b40d-3c6e-87410001d2fb.png)
1. On the left, select the **Security** tab.
1. Scroll down to the **Personal access tokens** section, and click on **Create token**.
1. Fill out the **Token description** field and select the appropriate expiration time (1 hour, 1 day, 1 month or never) for your token.
1. Fill out the **Name** field and select an expiration option for your token.
1. Click **Next**.
1. In the **Personal Access token** pop-up window, you can see your newly generated token.
1. Click **Copy and close** to store token in the clipboard so you can paste it somewhere safe, and to finalize.
Expand All @@ -42,4 +42,4 @@ You can regenerate an existing personal access token at any time. However, you c
1. Find your token in the **Personal access tokens** section.
1. Click **Edit**.
1. Click **Regenerate token**.
1. Copy the new token, and then click **Done**.
1. Copy the new token, and then click **Copy and close**.
6 changes: 1 addition & 5 deletions docs/bitrise-platform/accounts/resetting-your-password.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,8 @@ If you try to log in but you forgot your password:
1. Provide your **Email** or **Username** so that we know where to send password recovery link.
1. Check your inbox for the **Reset password instructions** sent by letsconnect.
1. Click **Reset Password** or copy the URL into your browser.
1. Add your new password and hit **Save**.
1. Add your new password and hit **Change Password**.
1. Once your password has been changed, click **Log in** to access our login page again.
1. Add your **Username** and new **Password** to log into your Bitrise Dashboard.

If you failed to log in for the third time, [reCAPTCHA](https://developers.google.com/recaptcha/) will get enabled to check if you are a human.

If you failed to log in for an excessive amount of attempts, you will automatically get locked out. Check your inbox for our **Unlock Instructions** email!

![Resetting_your_password.png](/img/_paligo/uuid-6466da39-be6a-66e4-fc28-662201fbb0b2.png)
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ To start configuring SAML SSO:

1. <Partial_OpeningTheWorkspaceSettingsPage />
1. Select the **Single Sign-On** tab on the left.
1. Click **Configure SAML SSO**. It opens the **Setup connection** screen.
1. Click **Configure SSO**. It opens the **Setup connection** screen.
1. Log in to your SAML SSO provider and add Bitrise as a SAML SSO application, using the values from the **Setup connection** screen in your Bitrise workspace settings:

![sso-setup.png](/img/_paligo/uuid-baadaff0-fbae-febb-cca3-077a707b1676.png)
Expand All @@ -77,21 +77,15 @@ If you’ve completed the steps, you and workspace members should get a verifica

## Checking SAML SSO statuses on Bitrise

Now that the Workspace owner has set up SAML SSO for the Workspace, all Workspace members (including the Workspace owner) can check their other Workspace member’s SAML SSO statuses on the **Team** tab.
Now that the Workspace owner has set up SAML SSO for the Workspace, all Workspace members (including the Workspace owner) can check their other Workspace member’s SAML SSO statuses on the **Collaboration** tab.

:::note[Accessing the Single Sign-on tab]
There are two kinds of SAML SSO statuses on Bitrise, shown as an icon in the Members table. Hover over the icon to see its status as a tooltip:

The **Single Sign-On** tab is only available for the Workspace owner.

:::

There are two kinds of SAML SSO statuses on Bitrise.

- **SAML IS ENABLED:** Login via SAML SSO is enabled.
- **SAML IS DISABLED:** The Workspace member has not enabled the SAML SSO connection yet. To enable it, the Workspace member has to follow the instructions in the verification email from Bitrise.
- **SAML is enabled:** Login via SAML SSO is enabled.
- **SAML is disabled:** The Workspace member has not enabled the SAML SSO connection yet. To enable it, the Workspace member has to follow the instructions in the verification email from Bitrise.

1. Go to your Workspace’s profile page.
1. Select **Team** from the left menu.
1. Select **Collaboration** from the left menu.
1. Go to the Members tab to check the Workspace member’s SAML status.

![saml_status.png](/img/_paligo/uuid-38cefb5d-2dc6-7a86-98cd-d1dac6484ded.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ SCIM provisioning requires a verified domain, and SCIM credentials: a SCIM base
1. On the left, select **Single sign-on**.
1. [Set up a verified domain](/en/bitrise-platform/accounts/saml-sso-in-bitrise/configuring-saml-sso-on-bitrise#verifying-your-domain).
1. Select the **SCIM** tab.
1. In the **SCIM credentials** section, click **Generate SCIM credentials** to open the SCIM credentials dialog box.
1. Save your SCIM credentials. In the dialog box, you will see:
1. In the **SCIM credentials** section, click **Connect with IdP** to open the **Connect with IdP** dialog.
1. Save your SCIM credentials. In the dialog, you will see:

- Your SCIM base URL.
- Your SCIM authentication token.

Copy and save both. You need them for SCIM provisioning.
Copy and save both. You need them for SCIM provisioning. Once you've pasted them into your identity provider, select the checkbox confirming this, and click **Done**.

For Okta, check out our [SCIM provisioning guide](/en/bitrise-platform/accounts/saml-sso-in-bitrise/setting-up-okta-sso-for-bitrise#setting-up-scim-provisioning-in-okta).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,11 @@ The exact process depends on how SAML SSO is configured for the workspace and wh

1. Open the Bitrise [sign-up](https://app.bitrise.io/users/sign_up) page and click **Sign up with SSO**.
1. Enter your work email address and click **Continue with SSO**.

![sign-up-saml.png](/img/_paligo/uuid-d696a899-d634-978b-1d7d-037f0a01ee5b.png)
1. Follow the instructions:

- If your workspace has a [verified domain](/en/bitrise-platform/accounts/saml-sso-in-bitrise/configuring-scim) matching your email's domain, you will be redirected to log in to the identity provider. After logging in, you will be redirected to Bitrise: provide a username and click **Finalize account**. You will receive an email with a confirmation link.
- If your workspace doesn't have a verified domain or if it doesn't match your email's domain, you will be asked to check your inbox. An email is sent with a secure login link that contains the available workspaces that use SAML SSO. To finish signing in to the workspaces, click the links in the email. You will be redirected to Bitrise to enter your username and finalize the account.

:::note[SAML SSO unavailable]

If you haven't been invited to a workspace and no workspace has your email domain verified, you will receive an error message at this stage that states you tried to use SAML SSO without a valid target. You can only sign up or log in without SSO.

:::

## Logging in to SAML SSO for existing users

If a workspace switches to using SAML SSO to log in, members might need to authorize SAML SSO separately, depending on the workspace configuration.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To configure SAML SSO with AD FS, you'll need to:

1. <Partial_OpeningTheWorkspaceSettingsPage />
1. Go to the **Single Sign-on** tab.
1. Add the **Identity provider sign-on URL** from AD FS in the **SAML SSO provider Single Sign-On URL (SSO URL)** field.
1. Add the **Identity provider sign-on URL** from AD FS in the **SSO URL** field.

For example, a valid value is `https://<AD FS URL>.com/adfs/ls`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ You will need to:
Once you have enabled Bitrise as a web application on Auth0, it’s time to grab the certificate and the Identity provider’s unique login URL to finish up the SAML configuration on Bitrise.

1. On Auth0, go to **Application**, then select the **Addons** tab to find your enabled Bitrise app.
1. Click the **SAML2 WEB APP** web app and select the **Usage** tab. Click on the **Download Auth0 certificate** link next to the **Identity Provider Certificate** label. Open the downloaded certificate file and copy its content into the **SAML SSO provider certificate** field of Bitrise or upload the file itself from your local computer. Go back to Auth0 and copy paste the **Identity Provider Login URL** into Bitrise’s **SAML SSO provider Single Sign-On URL (SSO URL)**.
1. Click the **SAML2 WEB APP** web app and select the **Usage** tab. Click on the **Download Auth0 certificate** link next to the **Identity Provider Certificate** label. Open the downloaded certificate file and copy its content into the **SAML SSO provider certificate** field of Bitrise or upload the file itself from your local computer. Go back to Auth0 and copy paste the **Identity Provider Login URL** into Bitrise’s **SSO URL** field.

![saml_sso_setup.png](/img/_paligo/uuid-26ad84be-65c7-1916-f079-6b553b4c436d.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,14 @@ Before setting up SAML to the app, you have to add all the users/groups to the a
![sso3-2.jpg](/img/_paligo/uuid-39c02a1a-b3f2-3922-a9d1-fac312c98f92.jpg)
1. Head back to your workspace on Bitrise: open the **Workspace settings** page and go to **Single Sign-On**
1. If you have more than one workspace using the same Entra instance, add its own Entity ID in the **Application identifier** field.
1. Click the **Copy Link** button to copy the **Assertion Consumer Service URL (ACS URL)** from Bitrise.
1. Click the **Copy** button to copy the **Assertion Consumer Service URL (ACS URL)** from Bitrise.
1. Let’s head back to the **Basic SAML Configuration** window of Entra ID.
1. Paste the **Assertion Consumer Service URL** from Bitrise to the **Reply URL field on the Basic SAML Configuration** page of Entra ID.
1. Click **Save** and close the **Basic SAML Configuration** window.

![616541a82bf14.jpg](/img/_paligo/uuid-681bee8c-6be9-b47f-06fa-72a587e7add7.jpg)
1. On the **Single sign-on** page of Entra ID, scroll down to the **Set up Bitrise** section.
1. Copy the **Login URL** and paste it to the **SAML SSO provider Single Sign-On URL** **(SSO URL)** field on Bitrise.
1. Copy the **Login URL** and paste it to the **SSO URL** field on Bitrise.
1. On the **Single sign-on** page of Entra ID, scroll up a bit to the **SAML Signing Certificate** section.
1. Click **Download** next to **Certificate (Base64)** to download the certificate to your local computer.

Expand All @@ -103,6 +103,6 @@ Before setting up SAML to the app, you have to add all the users/groups to the a

(If manually adding the content, you will need the full content (including `----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` as well).
1. Open the **Workspace settings** page on Bitrise and go to **Single Sign-On**.
1. Click **Apply SSO configuration**.
1. Click **Configure SSO**.

You have successfully set up Bitrise as a SAML SSO app on Entra ID.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The setup consists of three steps:
1. <Partial_OpeningTheWorkspaceSettingsPage />
1. Select **Single sign-on** from the left menu.
1. Select the **SCIM** tab.
1. Click **Generate SCIM credentials**.
1. Click **Connect with IdP**.
1. Copy and save both values shown in the dialog:
- **SCIM base URL**
- **SCIM authentication token**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ You'll need to:
![addappname.jpg](/img/_paligo/uuid-1a730b40-ecbe-d3dd-58a4-c46a0854f63a.jpg)
1. On the **Getting Identity Provider details** page:

- Copy the **SSO URL** and paste it on the **SAML SSO provider Single Sing-On URL (SSO URL)** on Bitrise.
- Copy the **SSO URL** and paste it on the **SSO URL** field on Bitrise.
- Copy the whole content of the **Certificate** field and paste it in the **SAML SSO provider certificate** field of Bitrise. You can upload the **Certificate** from your local computer too.

![identityproviderdetails.jpg](/img/_paligo/uuid-21e11866-5b32-ba61-b232-0336d27e75e9.jpg)
1. While you are in Bitrise, click the **Copy Link** button to copy the **Assertion Consumer Service URL (ACS URL)**. We will need it on Google Workspace in a second. Let’s NOT click the **Configure SSO** button just now!
1. While you are in Bitrise, click the **Copy** button to copy the **Assertion Consumer Service URL (ACS URL)**. We will need it on Google Workspace in a second. Let’s NOT click the **Configure SSO** button just now!
1. Let’s head back to the **Getting Identity Provider details** page of Google Workspace. Click **Continue**.
1. On the **Service provider details** page:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Before connecting SAML SSO to your <GlossTerm baseform="workspace">Workspace</Gl

![Setting_up_Idaptive_SAML_SSO_for_Bitrise.jpg](/img/_paligo/uuid-904a51d4-081b-8a05-0b56-3522007e3a46.jpg)
1. Insert the content or upload the file itself in the **SAML SSO provider certificate** text box on the **Enable Single Sign-On** page of Bitrise.
1. Copy the **Single Sign On URL** from the **Trust** page of Idaptive. Insert it on the **SAML SSO provider Single Sing-On URL (SSO URL)** field on the **Enable Single Sign-On** page of Bitrise.
1. Copy the **Single Sign On URL** from the **Trust** page of Idaptive. Insert it on the **SSO URL** field on the **Single sign-on** page of Bitrise.
1. While on the **Single Sign-On page** of Bitrise, copy the **Assertion Consumer Service URL (ACS URL)** URL and click **Configure SSO**.
1. Now let’s head back to Idaptive! Under **Service Provider Configuration** click **Manual Configuration**. Type **Bitrise** in the **SP Entity ID / Issuer / Audience** and paste the **Assertion Consumer Service URL (ACS URL)** from Bitrise to the **Assertion Consumer Service (ACS) URL** on Idaptive.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ We will be jumping back and forth from the Bitrise Workspace account to Okta so
1. At the **General Settings** step, type Bitrise into the **App name** field. (Optionally, you can add an app logo if you wish.) Click **Next**.

![general_settings_okta.png](/img/_paligo/uuid-e0ec0de8-1ae0-a3e9-ea57-fb0fa50b58df.png)
1. Head over to your Bitrise Workspace and click the **Single Sign On** tab on the left menu.
1. Head over to your Bitrise Workspace and click the **Single Sign-on** tab on the left menu.
1. Click the **Copy** button to copy the **Assertion Consumer Service URL (ACS URL)**.
1. Head back to Okta’s **Configure SAML** page and paste the copied URL from <GlossTerm baseform="step">Step</GlossTerm> 7. to the **Single sign-on URL** input field.
1. Type Bitrise at the **Audience URI (SP Entity ID)**.

You can download the Okta certificate file now, and paste its content or upload the file itself in the **SAML SSO provider certificate** field on your Bitrise Workspace’s **Single Sign-On** page. Even easier if you leave it for later as you will need to fill out the **Assertion Consumer Service URL (ACS URL)** on Bitrise anyway. You will fetch this while configuring Bitrise as a SAML app on Okta. Do not hit **Configure SSO** on the **Single Sing-On** page of Bitrise just yet.
You can download the Okta certificate file now, and paste its content or upload the file itself in the **SAML SSO provider certificate** field on your Bitrise Workspace’s **Single Sign-On** page. Even easier if you leave it for later as you will need to fill out the **Assertion Consumer Service URL (ACS URL)** on Bitrise anyway. You will fetch this while configuring Bitrise as a SAML app on Okta. Do not hit **Configure SSO** on the **Single Sign-on** page of Bitrise just yet.
1. Set the **Name ID format** to **EmailAddress**.

![saml_sso_config.png](/img/_paligo/uuid-26903c72-7c1d-66a1-37d7-15be1fbd6379.png)
Expand Down Expand Up @@ -85,6 +85,7 @@ Congrats! Bitrise has been successfully added to Okta as an app.
If you haven’t pasted the Certificate’s content or uploaded the file itself into the **SAML SSO provider certificate** field of your Bitrise Workspace yet, you can do so now.

![saml_sso_url.png](/img/_paligo/uuid-bce20b25-c8cc-fed6-c43c-627647f4c5a4.png)
1. Optionally, fill out the **SSO Logout URL** field, and the **Application Identifier** field if multiple Workspaces use this same Okta instance.
1. Click **Configure SSO** on your Bitrise Workspace.

That's it! From now on, whenever you access the **Single Sign-on** page, you can configure the SAML SSO settings.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ To configure Bitrise on OneLogin:
1. Go back to the **SSO** page on OneLogin and copy the **SAML 2.0 Endpoint (HTTP)** link. Paste it in the **SAML SSO provider Single Sign-On URL (SSO URL)** field on Bitrise.
1. Go back to Bitrise and click **Configure SSO**.

![enablesinglesignonpage.png](/img/_paligo/uuid-11509388-3538-06e7-23f3-7ef27a956386.png)

:::important[Users on OneLogin and Bitrise]

Make sure the users in your Bitrise Workspace are all added to the **Users** page on OneLogin. If not, go to **Users**, then **New User** and add the new user. Don’t forget to send out an invite (**More actions** drop-down menu, **Send Invitation**) to a new user so that the user can activate their account on OneLogin. Users must be added to the newly created Bitrise app by clicking **Applications** under **User Info** and clicking the **+** sign. Make sure the added users are all Workspace members on Bitrise.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@ To add Bitrise to Ping Identity:
1. At **Application Configuration**, leave the **I have the SAML configuration** selected. Fill out the following:

- **Assertion Consumer Service (ACS)** field: Insert the **Assertion Consumer Service URL (ACS URL)** link here from your Bitrise Workspace’s **Single Sign-On** tab.

![enablesinglesignonpage.png](/img/_paligo/uuid-11509388-3538-06e7-23f3-7ef27a956386.png)
- **Entity ID field**: Type `Bitrise`.
- **Signing**: Click the **Sign Response** option.

Expand All @@ -53,8 +51,6 @@ To add Bitrise to Ping Identity:

- Copy the entire content of the **SAML Metadata** file and paste it in the **SAML SSO provider** **certificate** field of your Bitrise **Single Sign-On** page.
- Open the **Signing Certificate** file and copy the `HTTP-POST` `SingleSignOnService Location` link and paste it in the **SAML SSO provider Single Sign-On URL (SSO URL)** field on Bitrise.

![enablesinglesignonpage.png](/img/_paligo/uuid-11509388-3538-06e7-23f3-7ef27a956386.png)
1. Click **Configure SSO** on Bitrise.

Now you have set up SAML SSO on your Bitrise Workspace.
Loading
Loading