Yahoo Social Identity Provider
Set Up Yahoo
To set up Yahoo as a social identity provider, navigate to the following page: Yahoo OAuth 2.0 Guide . You'll need a Yahoo account. You can then navigate to the Create an App page, where you can follow the Yahoo process to create a new web application with the following information:
Application Name
Web Application
Callback Domain, such as
openidm.example.com
; required for IDMAPI Permissions; for whatever you select, choose Read/Write. IDM only reads Yahoo user information.
When complete and saved, you should see a Client ID
and Client Secret
for your new web app.
Note
Yahoo supports URLs using only HTTPS, only on port 443. For more information on how to configure IDM to use these ports, see Host and Port Information.
Configure Yahoo as a Social Identity Provider
To configure Yahoo as a social identity provider, log in to the Admin UI and navigate to Configure > Social ID Providers.
Enable the Yahoo social identity provider.
In the
Yahoo Provider
pop-up that appears, the values forRedirect URI
should use the same Callback Domain as shown in "Set Up Yahoo".Include the values that Yahoo created for
Client ID
andClient Secret
, as described in "Set Up Yahoo".Click Show Advanced Options, and enter information, as necessary. A complete list of options is available here: "Yahoo Social Identity Provider Configuration Details".
When you enable a Yahoo social identity provider in the Admin UI, IDM generates the identityProvider-yahoo.json
file in your project's conf/
subdirectory.
When you review that file, you should see information beyond what you see in the Admin UI. The first part of the file includes the name of the provider, the scope, and UI settings related to the social identity provider icon (badge) and the sign-in button. For more information on the icon and button, see "Social Identity Provider Button and Badge Properties".
{ "provider" : "yahoo", "scope" : [ "openid", "sdpp-w" ], "uiConfig" : { "iconBackground" : "#7B0099", "iconClass" : "fa-yahoo", "iconFontColor" : "white", "buttonClass" : "fa-yahoo", "buttonDisplayName" : "Yahoo", "buttonCustomStyle" : "background-color: #7B0099; border-color: #7B0099; color:white;", "buttonCustomStyleHover" : "background-color: #7B0099; border-color: #7B0099; color:white;" },
Another part of the file includes a propertyMap
, which maps user information entries between the source
(social identity provider) and the target
(IDM).
The next part of the file includes schema
information, which includes properties for each social identity account, as collected by IDM, as well as the order in which it appears in the Admin UI. When you've registered a user with a Yahoo social identity, you can verify this by selecting Manage > Yahoo, and then selecting a user.
Next, there's the part of the file that you may have configured through the Admin UI, plus additional information on the redirectUri
, the configClass
, and the authenticationIdKey
:
"authorizationEndpoint" : "https://api.login.yahoo.com/oauth2/request_auth", "tokenEndpoint" : "https://api.login.yahoo.com/oauth2/get_token", "wellKnownEndpoint" : "https://api.login.yahoo.com/.well-known/openid-configuration", "issuer" : "https://api.login.yahoo.com", "clientId" : "<Client_ID_Name>", "clientSecret" : {encrypted-client-secret}, "authenticationIdKey" : "sub", "redirectUri" : "https://openidm.example.com/", "basicAuth" : false, "configClass" : "org.forgerock.oauth.clients.oidc.OpenIDConnectClientConfiguration", "enabled" : true
If you need more information about the properties in this file, refer to the following appendix: "Yahoo Social Identity Provider Configuration Details".
Configure User Registration to Link to Yahoo
Once you've configured the Yahoo social identity provider, you can activate it through User Registration. To do so in the Admin UI, select Configure > User Registration, and activate that feature. Under the Social tab that appears, enable Social Registration. For more information on IDM user self-service features, see "Self-Service End User UI".
When you enable Social Registration, you're allowing users to register on IDM through all active social identity providers.
Yahoo Social Identity Provider Configuration Details
You can set up the Yahoo social identity provider through the Admin UI or in a conf/identityProvider-yahoo.json
file. IDM generates the identityProvider-yahoo.json
file when you configure and enable this social identity provider in the Admin UI. Alternatively, you can create the file manually.
The following table includes the information shown in the Admin UI Yahoo Provider pop-up window, along with associated information in the identityProvider-yahoo.json
file.
Note
Yahoo supports URLs using only HTTPS, only on port 443. For more information on how to configure IDM to use these ports, see Host and Port Information.
Property (UI) | Property (JSON file) | Description |
---|---|---|
Client ID | clientId | The client identifier for your Yahoo App. |
Client Secret | clientSecret | Used with the Client ID to access the applicable Yahoo API. |
Scope | scope | An array of strings that allows access to user data. |
Authorization Endpoint | authorizationEndpoint | Typically, https://api.login.yahoo.com/oauth2/request_auth ; known as a Yahoo Authorize URL. |
Token Endpoint | tokenEndpoint | Endpoint that receives a one-time authorization code, and returns an access token. Typically, https://api.login.yahoo.com/oauth2/get_token . |
Well-Known Endpoint | wellKnownEndpoint | Access for other URIs. Typically, https://login.yahoo.com/.well-known/openid-configuration . |
Issuer | issuer | The token issuer. Typically, https://api.login.yahoo.com . |
Not in the Admin UI | provider | Name of the social identity provider. |
Not in the Admin UI | configClass | Configuration class for the authentication module. |
Not in the Admin UI | basicAuth | Whether to use basic authentication. |
Not in the Admin UI | propertyMap | Mapping between Yahoo and IDM. |
For information on social identity provider buttons and badges, see "Social Identity Provider Button and Badge Properties".