Modifying OAuth data after widget approval

During the approval process, the approver is prompted to enter the OAuth client consumer information if a gadget includes it. You can modify the OAuth consumer data as needed.

Procedure

  1. From the Domino® Administrator client, click Files, select the widget catalog and click to open the widget catalog.
  2. Open the widget you are working with, expand the Security section, and click the appropriate Edit button in the OAuth data table. The OAuth data table displays only if there is OAuth data in the widget. An Edit button displays only if there is OAuth data in the widget.

    If the OpenSocial gadget uses OAuth, a version of the Configure OAuth Consumer Information dialog box specific to the gadget's release of OAuth opens.

  3. Edit these settings as needed.
    Table 1. Fields in the Configure OAuth Consumer Information dialog box (1.0A)
    Field Description
    Application Id URL to the OpenSocial widget's XML file. Domino® supplies this value.
    Service Name Domino® supplies this value.
    OAuth Request Token URI Domino® supplies this value if the value is available in the XML file. The value is specific to the OAuth service in use.

    If the field does not contain a value, check with the original provider of the gadget that was used to create the OpenSocial widget.

    OAuth Access Token URI Domino® supplies the value in this field if the value is available in the XML file. The value is specific to the OAuth service in use.

    If the field does not contain a value, check with the original provider of the gadget that was used to create the OpenSocial widget.

    *Consumer Key** Part of the identification information used for authenticating the server with the resource provider. This value is obtained by means of a registration process with the resource provider.

    To determine this value, check with the original provider of the gadget that was used to create the OpenSocial widget.

    *Signature Method The signature style used when generating requests to a specific resource provider.

    To determine this value, check with the original provider of the gadget that was used to create the OpenSocial widget.

    *Consumer Secret** Part of the identification information used for authenticating the server with the resource provider. This value is obtained by means of a registration process with the resource provider.

    To determine this value, check with the original provider of the gadget that was used to create the OpenSocial widget.

    Table 2. Fields in the Configure OAuth Consumer Information dialog box (2.0)
    Field Description
    Application Id URL to the OpenSocial widget's XML file. Domino® supplies this value.
    Service Name Domino® supplies this value.
    AllowModuleOverrides True (default) or False

    Indicates whether or not URLs specified in the widget XML can be used. A value of true allows widget XML URLs to be used. A value of false will use only the URLs supplied from the database document.

    OAuth Authorization URL Domino® supplies this value if the value is available in the XML file. The value is specific to the OAuth service in use.

    If the field does not contain a value, check with the original provider of the gadget that was used to create the OpenSocial widget.

    OAuth Request Token URI Domino® supplies this value if the value is available in the XML file. The value is specific to the OAuth service in use.

    If the field does not contain a value, check with the original provider of the gadget that was used to create the OpenSocial widget.

    OAuth Access Token URI Domino® supplies this value if the value is available in the XML file. The value is specific to the OAuth service in use.

    If the field does not contain a value, check with the original provider of the gadget that was used to create the OpenSocial widget.

    *Consumer Key** Part of the identification information used for authenticating the server with the resource provider. This value is obtained by means of a registration process with the resource provider.

    To determine this value, check with the original provider of the gadget that was used to create the OpenSocial widget.

    *Consumer Secret** Part of the identification information used for authenticating the server with the resource provider. This value is obtained by means of a registration process with the resource provider.

    To determine this value, check with the original provider of the gadget that was used to create the OpenSocial widget.

    Client Type To determine this value, check with the original provider of the gadget that was used to create the OpenSocial widget.
    Grant Type To determine this value, check with the original provider of the gadget that was used to create the OpenSocial widget.
    ClientAuthorization Type To determine this value, check with the original provider of the gadget that was used to create the OpenSocial widget.
    UseAuthorizationHeader True (default) or False

    UseAuthorizationHeader is set to True by default. The UseAuthorizationHeader setting indicates whether or not to include OAuth2 protocol content items as headers. At least one of the fields UseAuthorizationHeader or UseUrlParameter should be set to true. Including the OAuth2 protocol content items as headers only is more secure than using url parameters, especially when using HTTPS.

    To determine this value, check with the original provider of the gadget that was used to create the OpenSocial widget.

    UseUrlParameter False (default) or True
    Indicates whether or not to include OAuth2 protocol content items as URL parameters. At least one of the fields UseAuthorizationHeader or UseUrlParameter should be set to true.
    Note: Including the OAuth2 protocol content items as headers only is more secure than using url parameters, especially when using HTTPS.

    To determine this value, check with the original provider of the gadget that was used to create the OpenSocial widget.

    SharedTokens False (default) or True

    Indicates whether or not an access token from a resource provider that matches the service name and consumer key can be used for multiple gadgets.

    To determine this value, check with the original provider of the gadget that was used to create the OpenSocial widget.

  4. Click OK.