||
Skip to end of metadata
Go to start of metadata

This page provides instructions on how to configure Foursquare authenticator and Identity Server for using a sample app. You can find more information in following sections.

This is tested with the Foursquare API version 2. Foursquare Authenticator is supported by Identity Server 5.1.0 upwards.

 

Configuring the Foursquare App

  1. Place the authenticator .jar file (org.wso2.carbon.extension.identity.authenticator.foursquare.connector-1.x.x.jar) into the <IS_HOME>/repository/components/dropins directory. You can download the .jar file from the WSO2 Store

    If you want to upgrade the Foursquare Authenticator in your existing IS pack, please refer upgrade instructions.

  2. Go to https://foursquare.com/ and login with your Foursquare account.

    If you do not have a Foursquare account, create an account by clicking Sign Up or sign in with your Facebook credentials.

  3. Go to https://developer.foursquare.com/ and click Log-in. You can create a new app in the My Apps section by clicking Create a New App


  4. Enter the following in the window that appears:

    • App name - TravelocityApp

    • Application Url - http://localhost:8080/travelocity.com

    • Redirect URL as  https://localhost:9443/commonauth  

  5. You can select Create App without Verifying link at the end in order to try out the authenticator.

  6. Save your changes.
    This takes you to the app Dashboard where you can find the Client Id and Client Secret as shown in the image below.

Now you have finished configuring Foursquare as an identity provider.

Deploying travelocity.com sample app

The next step is to deploy the sample app in order to use it in this scenario.

Once this is done, the next step is to configure the WSO2 Identity Server by adding a service provider and identity provider.

Configuring the identity provider

Now you have to configure WSO2 Identity Server by adding a new identity provider.

  1. Download the WSO2 Identity Server from here and run it.
  2. Log in to the management console as an administrator.
  3. In the Identity Providers section under the Main tab of the management console, click Add.
  4. Give a suitable name for Identity Provider Name (e.g., foursquare).
    Refer Adding and Configuring an Identity Provider for more information related to the identity provider configuration.
  5. Go to Foursquare Configuration under Federated Authenticators.

  6. Enter the IdP related details.

  7. Select both checkboxes Enable and Default to enable the Foursquare Authenticator and make it the default.

  8. Click Register.

You have now added the identity provider.

Configuring the service provider

The next step is to configure the service provider based on the WSO2 Identity Server version that you are working on.

Configuring a service provider with IS 5.3.0 upwards

  1. Return to the management console.

  2. In the Service Providers section under the Main tab, click Add.

  3. As you are using travelocity as the sample, enter travelocity.com in the Service Provider Name text box.

  4. Configure the SAML2 Web SSO Configuration details.
    For more information on theSAML2 Web Single-Sign-On Configuration methods, see Configuring SAML2 Web Single-Sign-On.
    1. In the Inbound Authentication Configuration section, click SAML2 Web SSO Configuration, and then click Configure.

    2. Now set the configuration as follows:

      1. Select Mode: Manual Configuration

      2. Issuer: travelocity.com

      3. Assertion Consumer URL: Enter the Assertion Consumer URL as  http://localhost:8080/travelocity.com/home.jsp and click Add.

    3. Select the following check-boxes:
      1. Enable Response Signing

      2. Enable Single Logout

      3. Enable Attribute Profile

      4. Include Attributes in the Response Always
  5. Click Register to save the changes. Now you will be sent back to the Service Providers page.

  6. Click Edit to edit the travelocity.com service provider.

  7. Configure the Local and Outbound Authentication for Foursquare.
    For more information, see Configuring Local and Outbound Authentication for a Service Provider in the WSO2 IS 5.3.0 guide.

    1. Go to the Local and Outbound Authentication Configuration section.

    2. Select the identity provider you created from the dropdown list under Federated Authentication.

    3. Ensure that the Federated Authentication radio button is selected.

  8. Click Update to save the changes.

Configuring a service provider with IS 5.1.0 or IS 5.2.0

  1. Return to the management console.

  2. In the Service Providers section under the Main tab, click Add.

  3. As you are using travelocity as the sample, enter travelocity.com in the Service Provider Name text box and click Register.

  4. In the Inbound Authentication Configuration section, click SAML2 Web SSO Configuration, and then click  Configure.

  5. Now set the configuration as follows:

    1. Issuer: travelocity.com

    2. Assertion Consumer URL: http://localhost:8080/travelocity.com/home.jsp

  6. Select the following check-boxes:
    1. Enable Response Signing

    2. Enable Single Logout

    3. Enable Attribute Profile

    4. Include Attributes in the Response Always
  7. Click Register to save the changes. Now you will be sent back to the Service Providers page.

  8. Go to the Local and Outbound Authentication Configuration section.

  9. Select the identity provider you created from the dropdown list under Federated Authentication.

  10. Ensure that the Federated Authentication radio button is selected and click Update to save the changes.

You have now added and configured the service provider.

Configuring claims

Add a new claim mapping for various user attributes related to Foursquare based on the WSO2 Identity Server version that you are working on.

Configuring claims with IS 5.3.0 upwards

  1. Sign in to the Management Console by entering your username and password.
  2. In the Main menu, click Add under Claims.
  3. Click Add Claim Dialect to create the Foursquare authenticator specific claim dialect.

  4. Specify the Dialect URI as http://wso2.org/foursquare/claims and click Add to create the claim dialect.

  5. Map a new external claim to an existing local claim dialect.
    You need to map at least one claim under this new claim dialect. Therefore, let's map the claim for the Foursquare user ID.
    1. In the Main menu, click Add under Claims.
    2. Click Add External Claim to add a new claim to the Foursquare claim dialect. 

    3. Select the  Dialect URI as - http://wso2.org/foursquare/claims
    4. Enter the  External Claim URI based on the following claim mapping information.
    5. Select the Mapped Local Claim based on the following claim mapping information. 

      Claim mapping for ID

      Dialect URIhttp://wso2.org/foursquare/claims
      External Claim URI

      http://wso2.org/foursquare/claims/id

      Mapped Local Claimhttp://wso2.org/claims/username
    6. Click Add to add the new external claim.

  6. Similarly, you can create claims for all the public information of the Foursquare user by repeating step 5 with the following claim mapping information. 

    • Claim mapping for email

      Dialect URIhttp://wso2.org/foursquare/claims
      External Claim URI

      http://wso2.org/foursquare/claims/email

      Mapped Local Claimhttp://wso2.org/claims/emailaddress
    • Claim mapping for first name

      Dialect URI

      http://wso2.org/foursquare/claims

      External Claim URI

      http://wso2.org/foursquare/claims/firstName

      Mapped Local Claim

      http://wso2.org/claims/givenname
    • Claim mapping for last name

      Dialect URI

      http://wso2.org/foursquare/claims

      External Claim URI

      http://wso2.org/foursquare/claims/lastName

      Mapped Local Claim

      http://wso2.org/claims/lastname
    • Claim mapping for gender

      Dialect URI

      http://wso2.org/foursquare/claims

      External Claim URI

      http://wso2.org/foursquare/claims/gender

      Mapped Local Claim

      http://wso2.org/claims/gender
    • Claim mapping for home city

      Dialect URI

      http://wso2.org/foursquare/claims

      External Claim URI

      http://wso2.org/foursquare/claims/homeCity

      Mapped Local Claim

      http://wso2.org/claims/location
    • Claim mapping for canonical URL

      Dialect URI

      http://wso2.org/foursquare/claims

      External Claim URI

      http://wso2.org/foursquare/claims/canonicalUrl

      Mapped Local Claim

      http://wso2.org/claims/url
  7. The next step is to configure claims in the Identity Server and map them with Foursquare.

    1. In the Identity section under the Main tab, click List under Identity Providers.
    2. Click Edit to edit the Foursquare identity provider you created. 
    3. Under Claim Configuration, go to Basic Claim Configuration.
    4. Select the Define Custom Claim Dialect option under Select Claim mapping Dialect
    5. Click Add Claim Mapping to add custom claim mappings as follows.

      Identity Provider URILocal Claim URI

      http://wso2.org/foursquare/claims/id

      http://wso2.org/claims/username

      http://wso2.org/foursquare/claims/emailhttp://wso2.org/claims/emailaddress
      http://wso2.org/foursquare/claims/firstNamehttp://wso2.org/claims/givenname
      http://wso2.org/foursquare/claims/lastNamehttp://wso2.org/claims/lastname

      http://wso2.org/foursquare/claims/gender

      http://wso2.org/claims/gender

      http://wso2.org/foursquare/claims/homeCity

      http://wso2.org/claims/location
      http://wso2.org/foursquare/claims/canonicalUrlhttp://wso2.org/claims/url
    6. Select the User ID Claim URI as - http://wso2.org/foursquare/claims/id

    7. Click Update.

Configuring claims with IS 5.1.0 or IS 5.2.0

  1. Sign into the Management Console by entering your username and password.
  2. In the Main menu, click Add under Claims.
  3. Click Add New Claim Dialect to create the Foursquare authenticator specific claim dialect.
    Specify the Dialect Uri as http://wso2.org/foursquare/claims and create claims. It is required to create at least one claim under this new dialect. Therefore, create the claim for the Foursquare user ID while creating the claim dialect. Enter the following values the form.

    Display NameUser ID
    DescriptionClaim to user ID            
    Mapped Attribute

    uid

    Claim URL

    http://wso2.org/foursquare/claims/id

    Supported by Defaultselected
  4. Click Add to add the new claim.
  5. Similarly, you can create claims for all the public information of the Foursquare user. Add the following claims under the dialect http://wso2.org/foursquare/claims 

    Display NameEmail Address
    DescriptionClaim to email address
    Mapped Attributemail
    Claim URL

    http://wso2.org/foursquare/claims/email

    Supported by Defaultselected
    Display NameFirst Name
    DescriptionClaimtofirstname       
    Mapped Attribute

    givenName

    Claim URL

    http://wso2.org/foursquare/claims/firstName

    Supported by Defaultselected
    Display NameLastName
    DescriptionClaim to last name      
    Mapped Attribute

    sn

    Claim URL

    http://wso2.org/foursquare/claims/lastName

    Supported by Defaultselected
    Display NameGender
    DescriptionClaim to the gender of the user
    Mapped Attribute

    gender

    Claim URLhttp://wso2.org/foursquare/claims/gender
    Supported by Defaultselected
    Display Name

    Home City

    DescriptionClaim to Home city
    Mapped Attribute

    locality

    Claim URLhttp://wso2.org/foursquare/claims/homeCity
    Supported by Defaultselected
    Display Name

    Canonical Url

    DescriptionClaim to the canonical Url
    Mapped Attribute

    url

    Claim URLhttp://wso2.org/foursquare/claims/canonicalUrl
    Supported by Defaultselected

  6. The next step is to configure claims in the Identity Server and map them with Foursquare.

    1. In the Identity section under the Main tab, click List under Identity Providers.
    2. Click Edit to edit the foursquare identity provider you created. 
    3. Under Claim Configuration, go to Basic Claim Configuration.
    4. Select the Define Custom Claim Dialect option under Select Claim mapping Dialect
    5. Click Add Claim Mapping to add custom claim mappings as follows.
    6. Select the User ID Claim URI as - http://wso2.org/foursquare/claims/id

    7. Click Update.

Local claim mapping

Navigate to the Main menu, and click Add under Claims in the Management Console. The list of claims appear. Click the http://wso2.org/claims claim, and thereafter click email. This shows you that by default, the local claim  http://wso2.org/claims/emailaddress is created with the map attribute mail.

In the configuration, http://wso2.org/foursquare/claims/email is mapped to the mail attribute in the Foursquare claim, and http://wso2.org/claims/emailAddress is mapped to the mail attribute in WSO2 local claim.


Creating a new local claim to map it with the Foursquare claim

You can create the local claim http://wso2.org/claims/id with the map attribute uid as follows:

  1. In the Main menu, click Add under Claims.
  2. Click Add Local Claim to create a new local claim.

  3. Specify the following:

    • Claim URIhttp://wso2.org/claims/id

    • Display Name - ID

    • Description - Identifier
    • Mapped Attribute (s) - uid
    • Supported by Default - Select this option.
  4. Click Add.

  1. In the Main menu, click Add under Claims.
  2. Click Add New Claim Dialect to create the wso2.org specific claim dialect.

  3. Click Add.


Configuring requested claims for travelocity.com

  1. In the Identity section under the Main tab, click List under Service Providers.
  2. Click Edit to edit the travelocity.com service provider.
  3. Expand the Claim Configuration section.
  4. Click on Add Claim URI under Requested Claims to add the requested claims as indicated in the image below. Here you must add the claims you mapped in the Identity Provider claim configuration.

    Select the Mandatory Claim checkbox for all the claim URIs that you added.

  5. Select the Subject Claim URI as http://wso2.org/claims/emailaddress to define the authenticated user identifier that will return with the authentication response to the service provider.

  6. Click Update to save your service provider changes.

Testing the sample

  1. To test the sample, go to the following URL:
    http://<TOMCAT_HOST>:<TOMCAT_PORT>/travelocity.com/index.jsp
    E.g., http://localhost:8080/travelocity.com 

  2. Click the link to log in with SAML from WSO2 Identity Server. You can use either the redirect binding or the post binding option.
  3. You are redirected to the Foursquare Login page. Enter your Foursquare credentials and you will be taken to the home page of the travelocity.com app.
  • No labels