Adding OAuth friend servers for OpenSocial gadgets

If an OpenSocial gadget must communicate with an external server that requires authentication, you can add the external server as a friend server by providing an OAuth consumer key and secret.

Before you begin

You must be a repository administrator to add friend servers.

You must have an OAuth consumer key and secret from the external server. The steps to create consumer keys and secrets depend on the server.

If you are adding an IBM® Jazz™ server as a friend server, you do not need to generate an OAuth consumer key and secret. Instead, you can request a consumer key to add the Jazz server as a friend server.

If you are a community administrator, you can send a request to the repository administrator to add a friend server.
  1. Log in to the Rational Asset Manager web application.
  2. Click Administration.
  3. Click the name of your community.
  4. Click the Connections tab.
  5. In the Jazz Server Connections section, click View Connections. The Cross-Server Communication page opens.
  6. In the Friend Servers section, click Request new Friend Server.
  7. In the Request Friend Server window, type the URL address for the server for which you want to be a friend server.
  8. Click OK. Repository administrators will receive a notification with your request. The request is also a task on their My Dashboard page.

Procedure

To add a friend server:

  1. Log in to the web application.
  2. Click Administration.
  3. In the Repository Administration sidebar, click Cross-Server Communications.
  4. In the Friend Servers section, click New Friend Server.
  5. Type the following information about the friend server:
    Option Description
    Name A descriptive name for the server connection
    Description An optional description of the key
    Consumer key The consumer key provided by the external server
    Consumer secret The consumer secret that accompanies the consumer key
    Server type Select Non-Jazz Server. To add a Jazz server, see Adding IBM Jazz servers as friend servers.
    URL The fully qualified URL (including the port number, if necessary) for the external server
    OAuth request URL If the external server requires a specific URL to obtain request tokens, enter it here.
    OAuth authorization URL If the external server requires a different URL to obtain user authorization for access, enter it here.
    OAuth access URL If the external server requires a different URL for access tokens, enter it here.
  6. Click OK.

What to do next

OpenSocial gadgets in Rational Asset Manager can now communicate with the friend server.


Feedback