diff options
author | Małgorzata Ksionek <meksionek@gmail.com> | 2019-05-07 08:34:13 +0200 |
---|---|---|
committer | Małgorzata Ksionek <meksionek@gmail.com> | 2019-05-07 08:34:13 +0200 |
commit | 75186b57943d1a53d8084a9b5bc7f9085d5f85f1 (patch) | |
tree | a23cae53d66d9ed020620558f1a0306fecb83d80 | |
parent | 97fa2bf90da6489e84b143f4d7b00395b634ffc7 (diff) | |
download | gitlab-ce-57077-add-salesforce-omniauth.tar.gz |
Add remarks to docs57077-add-salesforce-omniauth
-rw-r--r-- | doc/integration/salesforce.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/integration/salesforce.md b/doc/integration/salesforce.md index 6affcaa1d02..18d42486fd6 100644 --- a/doc/integration/salesforce.md +++ b/doc/integration/salesforce.md @@ -1,6 +1,6 @@ # SalesForce OmniAuth Provider -You can integrate your GitLab instance with [SalesForce](https://www.salesforce.com/) to enable users to to login to your GitLab instance with your SalesForce account. +You can integrate your GitLab instance with [SalesForce](https://www.salesforce.com/) to enable users to login to your GitLab instance with their SalesForce account. ## Create SalesForce Application @@ -9,21 +9,20 @@ To get the credentials (a pair of Client ID and Client Secret), you must registe 1. Sign in to [SalesForce](https://www.salesforce.com/). -1. Navigate to **Platform Tools/Apps** and click on "New Connected App". +1. Navigate to **Platform Tools/Apps** and click on **New Connected App**. -1. Fill in the application details. - - Connected App Name, API Name: This can be anything. Consider something like `<Organization>'s GitLab` or `<Your Name>'s GitLab` or - something else descriptive. - - Description: Create a description. +1. Fill in the application details into the following fields: + - **Connected App Name** and **API Name**: Set to any value but consider something like `<Organization>'s GitLab`, `<Your Name>'s GitLab`, or something else that is descriptive. + - **Description**: Description for the application. ![SalesForce App Details](img/salesforce_app_details.png) -1. Select "API (Enable OAuth Settings)" and click on "Enable OAuth Settings". -1. Fill in the application details. - - Callback URL: Callback URL: `https://gitlab.example.com/users/auth/salesforce/callback` - - Selected OAuth Scopes: Move "Access your basic information (id, profile, email, address, phone)" and "Allow access to your unique identifier (openid)" to the right column. +1. Select **API (Enable OAuth Settings)** and click on **Enable OAuth Settings**. +1. Fill in the application details into the following fields: + - **Callback URL**: The call callback URL. For example, `https://gitlab.example.com/users/auth/salesforce/callback`. + - **Selected OAuth Scopes**: Move **Access your basic information (id, profile, email, address, phone)** and **Allow access to your unique identifier (openid)** to the right column. ![SalesForce Oauth App Details](img/salesforce_oauth_app_details.png) -1. Click "Save". +1. Click **Save**. 1. On your GitLab server, open the configuration file. @@ -76,4 +75,5 @@ On the sign in page, there should now be a SalesForce icon below the regular sig Click the icon to begin the authentication process. SalesForce will ask the user to sign in and authorize the GitLab application. If everything goes well, the user will be returned to GitLab and will be signed in. -**Note:** GitLab requires the email address of each new user. Once the user is logged in using SalesForce, GitLab will redirect the user to the profile page where they will have to provide the email and verify the email. +NOTE: **Note:** +GitLab requires the email address of each new user. Once the user is logged in using SalesForce, GitLab will redirect the user to the profile page where they will have to provide the email and verify the email. |