This documentation supports the 20.08 version of BMC Helix Platform. 
To view an earlier version, select 20.02 from the Product version menu.

Configuring the authentication credentials of REST API web services

BMC Helix Platform allows you to connect you application with the REST API web services of another application in a codeless way. After creating a one-time REST API web service definition, you must configure the authentication credentials of the REST API web services to which you want to connect in a codeless way. For example, if you want to connect to a JIRA REST API web service, you must configure the authentication credentials of JIRA service. 

BMC Helix Platform supports Basic Authentication (Basic Auth), Open Authorization 2.0 (OAuth 2.0) with client_credentials grant type, Remedy Single Sign-On (Remedy SSO), Custom, and Remedy (Without RSSO).

Before you begin

  • Ensure that you have the authentication credentials of the REST API web service that you want your application to connect to. 
  • Ensure that you have created the RESTful web service request definition. For more information, see Creating a REST API web service request definition
    For example, if you want to provide the authentication credentials of JIRA REST service, you must create the JIRA web service request definition.  
  •  If you want to use Remedy SSO, ensure that the OAuth client is registered in Remedy Single Sign-On (RSSO). When registering OAuth 2.0, ensure that you copy the Client ID and Client secret. To see the steps to register a client, see  Configuring OAuth 2.0 Open link  in Remedy Single Sign-Ononline documentation.

To configure the authentication credentials

  1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab. 
  2. Select Connections Web APIs
  3. On the Web API Connection page, click New.
  4. On the General tab, in the Name field, type a meaningful name for the REST API web service connection, such as JIRA connection.
  5. In Host Name, provide the host name from which the connection is established, such as jira.com.
  6. Fill out the Port and the Protocol fields.
  7. In Authentication, select one of the supported types: Basic Auth, OAuth  2.0, or RSSO.
  8. To add the authentication credentials, click Next
    The following image is an example of configuring authentication credentials for JIRA REST API:

    The following table lists the field values that you should specify based on the authentication that you select:

    AuthenticationField values
    Basic Auth
    • Login—Enter basic authorization user name of the REST API web service.
    • Password—Enter the password of the basic authorization protocol.
    • (Optional) If the REST API web service requires custom headers to establish a connection, in Headers, add the headers and the values.
    OAuth 2.0
    • Access Token URL—Enter the resource of the URL from which access tokens are generated for the REST service.
      Example: If the URL is http://api.jira.com/oauth2/token, in the Access Token URL field, type /oauth2/token.
    • Client ID—Enter the client ID of the REST API service.
    • Client Secret—Enter the client secret of the REST API service.
    • (Optional) In Scope, specify the restricted scope of access for these credentials.
    • (Optional) In Authorization Server Endpoint, specify the server name.
    • (Optional) If the RESTful service requires custom headers to establish a connection, in Headers, add the headers and the values.
    RSSO
    • Login Name—Enter the Remedy SSO user name.
    • Access Token URL—Enter the resource of the URL from which access tokens are generated for the REST service.
      Example: If the URL is http://api.servername.com/rsso/oauth2/token, in the Access Token URL field, type /rsso/oauth2/token.
    • In Client ID and Client Secret, enter the details that you obtained when registering the OAuth client.
    • (Optional) In RSSO Server Endpoint, select one of the following options:
      • Default—If the Remedy SSO server is the same as the Hostname provided on the General tab.
      • Enter RSSO Server EndpointIf the Remedy SSO server is different that the one specified as the Hostname provided on the General tab, enter the RSSO server endpoint in the following format:
        https:/servername:port
    • (Optional) If the RESFful service requires custom headers to establish a connection, in Headers, add the headers and the values.

    Remedy (Without RSSO)

    • Login ID—Enter the user ID of a Remedy user.

    • Password—Enter the password of a Remedy user.

    • Specify Headers and their values, if required.

    Custom

    • Specify header or query parameter, or both.

  9. Click Save

Where to go from here

Configuring web requests in a business process


Was this page helpful? Yes No Submitting... Thank you

Comments