Skip to content

Commit

Permalink
Add CONNECTOR docs
Browse files Browse the repository at this point in the history
  • Loading branch information
brionmario committed Aug 1, 2022
1 parent 8a39b0d commit 98ba840
Showing 6 changed files with 75 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -219,6 +219,10 @@ npm run build:external:static

The respective build artifacts could be found inside the build folder. (`apps/(myaccount|console)/build`)

## Connectors

Go through our [connectors guide](./docs/CONNECTORS.md) to learn how to handle connectors in the Identity Server Console.

## Troubleshoot

- If you face any out of memory build failures, make sure that you have set maven options to `set MAVEN_OPTS=-Xmx384M`
19 changes: 19 additions & 0 deletions docs/CONFIGURATION.md
Original file line number Diff line number Diff line change
@@ -713,3 +713,22 @@ applications.developer_app.configs.path = "<PATH>" # Path to navigate the users
> :negative_squared_cross_mark: No value defined in Default JSON
App extensions configuration.

#### `connectors`

> :bulb: No value defined in Default JSON
Add UI metadata for the connectors you add to the Identity Server instance.

> 📖 For more information, read through [Connectors guide](./CONNECTORS.md).

The following configuration adds UI metadata for the LinkedIn connector.

```toml
[[console.extensions.connectors]]
authenticatorId="TGlua2VkSW4"
description="Login users with existing LinkedIn accounts"
displayName="LinkedIn"
icon="https://brand.linkedin.com/content/dam/me/business/en-us/amp/brand-site/v2/bg/LI-Bug.svg.original.svg"
```
52 changes: 52 additions & 0 deletions docs/CONNECTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Connectors

## Authenticators

An authenticator allows you to authenticate the user using third party authentication systems such as LinkedIn, Duo security and Foursquare.

By default Identity Server packs several of these Authenticators and they are available to be configured via the Console.

But WSO2 has a wide range of authenticators in the [connector store](https://store.wso2.com/store/assets/isconnector/list) that you can plugin in to your Identity Server instance.

Let's see how we can configure LinkedIn connector in Console.

### Steps

1. Download the [LinkedIn connector](https://store.wso2.com/store/assets/isconnector/details/3a4f9dd9-be56-4e79-a925-8d8a4ace5a8f) from WSO2 connector store.(`org.wso2.carbon.extension.identity.authenticator.linkedin.connector-x.x.x`).

2. Place the authenticator.jar file into the
`<IS_HOME>/repository/components/dropins` directory.

3. Re-start the WSO2 Identity Server.

> 💡 For more in formation, read through the [connector documentation](https://github.com/wso2-extensions/identity-outbound-auth-linkedIn/blob/master/docs/README.md).
4. Login to Console (https://localhost:9443/console)

5. Navigate to `Develop > Identity Providers > New Identity Provider` and create an IdP with the `Expert Mode` IdP template.

![Create IdP with Expert Mode](./assets/create-idp-with-expert-mode.png)

6. Once the IdP is created, navigate to the `Settings` tab and click on `Add Authenticator` button.

7. Select `LinkedIn` from the authenticator selection and proceed with configuration.

![Configure LinkedIn connector](./assets/configure-linkedin-connector.png)

### (🦄 Optional) Add connector metadata to supplement the UI

Optionally, you can add a `display name`, `icon` and a description to the newly added connector to make the UI nicer 😉.

Add something like the following in the `<IS_HOME>/repository/conf/deployment.toml`.

> 💡 UI maps the meta data with the `authenticatorId`. This can be found by checking the `Browser Network` tab when the authenticators are loaded in the `Settings` tab.
```toml
[[console.extensions.connectors]]
authenticatorId="TGlua2VkSW4"
description="Login users with existing LinkedIn accounts"
displayName="LinkedIn"
icon="https://brand.linkedin.com/content/dam/me/business/en-us/amp/brand-site/v2/bg/LI-Bug.svg.original.svg"
```

![Configure LinkedIn connector](./assets/configure-linkedin-connector-with-meta.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/configure-linkedin-connector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/create-idp-with-expert-mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 98ba840

Please sign in to comment.