Publish REST Service Proxy Wizard

The Publish REST Service Proxy Wizard is used to publish a REST service proxy on the Gateway.
gateway91
The Publish REST Service Proxy Wizard is used to publish a REST service proxy on the Gateway.
Contents
 
It is recommended that you disable the new REST service proxy endpoint until its policy is completed. For information on disabling a service, see Published Service Properties.
 
 To access the Publish REST Service Proxy Wizard, do any of the following:
  • Click 
    Publish RESTful Service Proxy with WADL
     on the Policy Manager Home Page.
  • Select [
    Tasks
    ]
    > Services and APIs >
    Publish RESTful Service Proxy with WADL
     from the Main Menu.
  • Right-click a folder within the Services and Policies  list and then select 
    Publish RESTful Service Proxy with WADL
    .
Complete the wizard as described below. Once the wizard is complete, the new REST service proxy will appear in the Services and Policies list.
Step 1: Deploy REST Service From
Choose how to import the REST service:
  • Manual Entry:
     Choose this to manually specify the Service Name and Resource Base URL.
  • Deploy from WADL:
     Choose this to import information from a WADL.
Step 2: REST Proxy Configuration
In this step, configure the REST proxy:
If you are manually configuring the proxy, complete the following.
  • Service Name:
     Enter a name for the non-SOAP application. Upon publication, this name will appear on the Services and Policies list.
  • Resource Base URL:
     Enter the required Resource Base URL of the RESTful Service.
  • Gateway URI:
     The default Gateway URI is displayed. This URI is based on the path from the Resource Base URL. If you need to override the Gateway URI, select the Override Gateway URI check box and type in a different URI.
If you are deploying from a WADL, complete the following.
  • Location:
     Enter the location of the WADL file or click [File] to locate it.
  • Load:
     Click this button to load the WADL file once a valid location is entered. The button is disabled until a local existing file has been specified or a valid HTTP(S) URL has been specified in the location field.
  • HTTP Options:
     To configure options for the URL (for example, to specify the credentials or configure a proxy), click [HTTP Options] to open the Manage HTTP Options dialog.
  • Override Gateway URI:
     If you need to override the displayed URI for the Gateway, select this check box to make the Gateway URI column editable. Double-click in the Gateway column to enable editing. Press [Enter] when done.
 
The Resource Base URL column is not editable. However, the Service Name column is editable by default, whereas the Gateway URI column is editable only when "Override Gateway URI" is checked.
Step 3: Access Control
The Access Control step allows you to define access control and authentication rules for the non-SOAP application.
  1. Select the Require SSL/TLS Encryption check box to require that all requestors consume the application through the SSL entry point.
  2. Choose an access control option:
    • Select Allow Anonymous Access to permit requestors to access the application anonymously (without credentials).
    • Select Require Users to Authenticate to require that requestors provide credentials to gain application access. Define the authentication details for this option as follows:
    • Authentication Method: Select an authentication method from the drop-down list. This determines what information users and groups are required to provide to gain application access.
    • Identity Provider: Select an identity provider that contains the authorized users and groups from the drop-down list.
     
    When requiring users to authenticate, the access will be restricted to the identity providers indicated above. The policy will initially be populated with an authentication assertion for each Authenticate User or Group assertion corresponding to each selected identity.
  3. Specify which users and groups are authorized to use the application by moving them between the No Permission and Have Permission lists.
    • Grant permission by selecting entries from No Permission and then clicking [
      Add
      ]. Alternatively, click [
      Add All
      ] without selecting any entry to authorize everyone on the list.
    • Deny permission by selecting entries from Have Permission and then clicking [
      Remove
      ]. Alternatively, click [
      Remove All
      ] without selecting any entry to deny permission to everyone on the list
    You can select a continuous block of rows by dragging the mouse over the rows you want; or, select the first row, hold down the [Shift] key, then select the last row. You can select individual rows by holding down the [Ctrl] key while clicking on the rows you want.
  4. If you need to authorize users or groups from another identity provider, select the new provider name from the Identity Provider drop-down list and then repeat step 3.