Skip to content

Add a readme and fix startup issues #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
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
3 changes: 2 additions & 1 deletion component/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@
<Import-Package>
org.apache.commons.logging.*; version="1.0.4",
org.osgi.framework,
org.wso2.carbon.identity.application.authentication.framework.*,
org.wso2.carbon.identity.application.authentication.framework.*;version="${carbon.identity.package.import.version.range}",
org.wso2.carbon.identity.application.common.*;version="${carbon.identity.package.import.version.range}",
javax.servlet,
javax.servlet.http,
org.apache.oltu.oauth2.*;
Expand Down
105 changes: 105 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
# Configuring Bitly Authenticator In Identity Server

This guide provides instructions on how to configure the Bitly authenticator and add Bitly login to your applications using WSO2 Identity Server, enabling users to log in with their Bitly accounts.

> For WSO2 Identity Server versions prior to 7.0.0, please refer this [documentation](../README.md) for the configuration process applicable to those earlier releases.

Follow the steps given below to set this up.

## Configure the Bitly Authenticator

1. Download the .jar file from the [WSO2 Store](https://store.wso2.com/connector/identity-outbound-auth-bitly)

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

3. Start or restart the WSO2 Identity Server.

## Register WSO2 Identity Server on Bitly

1. Navigate to Bitly [Create an app page](https://app.bitly.com/settings/api).

2. Enter the required details.
* Application name.
* Application link.
* Redirect URIs (Callback URIs. The default redirect URL in WSO2 Identity Server is `https://localhost:9443/commonauth`.).
3. Click on **Save**. You will be redirected to the **Settings** page of the created application.

![bitly-app-create-page](img/bitly-app-create-page.png)

4. Copy the **Client ID** and **Client Secret** from the page.

## Register the Bitly IdP

Next, let's register the Bitly IdP in WSO2 Identity Server.

1. On the WSO2 Identity Server Console, go to **Connections**.

2. Click **Create Connection** and select Custom Connector.

3. Enter a unique name and a description and click Create.

![bitly-connector-create](img/bitly-connector-create.png)

4. Go to **Settings** tab and click **New Authenticator**.

5. Select the **Bitly** authenticator you want to add and click Next.

![bitly-select-authenticator](img/bitly-select-authenticator.png)

6. Enter the requested details of the authenticator and click Finish.

![bitly-add-authenticator](img/bitly-add-authenticator.png)

<table>
<thead>
<tr class="header">
<th>Parameter</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Client Id</td>
<td>The client ID obtained from Bitly app.</td>
</tr>
<tr class="odd">
<td>Client Secret</td>
<td>The client secret obtained from Bitly app.</td>
</tr>
<tr class="odd">
<td>Callback URL</td>
<td>This is the URL to which the browser should be redirected after the authentication is successful.
It should have this format: https://(host-name):(port)/commonauth</td>
</tr>
</tbody>
</table>


## Enable Bitly login

> You need to [register an application with WSO2 Identity Server](https://is.docs.wso2.com/en/latest/guides/applications/). You can register your own application or use one of the [sample applications](https://is.docs.wso2.com/en/latest/get-started/try-samples/) provided.


1. On the WSO2 Identity Server Console, go to **Applications**.
2. Select your application, go to the Login Flow tab and add Bitly login from your preferred editor:

a. Click Add Sign In Option to add a new authenticator to the first step.

b. Select the Bitly connection.

c. Click Confirm to add login with Bitly to the sign-in flow.

3. Click Update to save your changes.

## Try it out

Follow the steps given below.

1. Access the application URL.

2. Click Login to open the WSO2 Identity Server login page.

3. On the WSO2 Identity Server login page, Sign in with Bitly.

4. Log in to Bitly with an existing user account.
Binary file added docs/img/bitly-add-authenticator.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/img/bitly-app-create-page.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/img/bitly-connector-create.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/img/bitly-select-authenticator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,7 @@
</distributionManagement>
<properties>
<carbon.identity.version>5.0.7</carbon.identity.version>
<carbon.identity.package.import.version.range>[5.0.0,8.0.0)</carbon.identity.package.import.version.range>
<commons-logging.version>4.4.3</commons-logging.version>
<carbon.kernel.version>4.4.3</carbon.kernel.version>
<oltu.version>1.0.0.wso2v2</oltu.version>
Expand Down
Loading