Enable OAuth with inbound REST

Using OAuth, you can pass a user ID and password once, and then use a token for subsequent REST requests instead of submitting credentials with each request.

About this task

OAuth can improve system security by reducing the number of times you submit user credentials. You can use OAuth to authenticate REST requests.

This video demonstrates how to authenticate to REST APIs using OAuth.

Procedure

1. Activate the OAuth 2.0 plugin.
   See Activate a plugin to learn how to activate plugins.
2. Set the system property com.snc.platform.security.oauth.is.active to true.
3. Navigate to System OAuth > Application Registry.
4. Click New and then click Create an OAuth API endpoint for external clients.
5. Record the client_id and client_secret values from the previous step to use when requesting an access token.
   Note:

   The example shown is about creating OAuth API endpoint using password grant type. You can also configure OAuth API endpoint using other grant types. For more information, see OAuth Inbound.
6. To get an access token, use your REST client, such as cURL or Postman, to send a request to the OAuth endpoint (oauth_token.do).

   Format the request as a URL-encoded HTTP POST body and include the required parameters.

7. Record the access token and refresh token from the response.
8. Submit the access token with subsequent REST requests.

• REST OAuth example
  This example shows how to authenticate an inbound REST request using OAuth.