SecureRESTAPI

Stable Version 1.0.0 (OutSystems 10)
Published on 08 August 2018 by 
Created on 08 August 2018
Details
Basic: To invoke the REST API, a team will need to specify a username and password on the HTTP headers of the request;
Read More

When exposing a REST API, a team can configure the service to require authentication. There are three authentication modes available:

  • None: Anyone can invoke the API without needing to authenticate;

  • Basic: To invoke the REST API, a team will need to specify a username and password on the HTTP headers of the request;

  • Custom: An organization can implement their own authentication mechanism. 


Basic authentication

To require username/password authentication in a team's REST APIs, a team has the option to add basic authentication. This is done in the visual editor by setting the 'Authentication' parameter for the service.

Once a service has basic authentication, all clients that use the API need to send the credentials on the HTTP headers of the request. If no credentials are present, OutSystems automatically sends a JSON response with an error message, which looks like:

{
  "Errors": [
    "Basic Authentication required."
  ],
  "StatusCode":401
}

When clients send their credentials, OutSystems makes them available as parameters. This automates much of the boilerplate code that developers need to implement authentication functionality.


Reviews (0)
Category
Developer Tools
Tags
Support Options
This component is not supported by OutSystems. You may use the discussion forums to leave suggestions or obtain best-effort support from the community, including from Vijay Malviya who created this component.
Dependencies
SecureRESTAPI has no dependencies.
Requirements
Platform:
10.0.0.402
Database:
All
Stack:
All
Component Consumers
No consumers yet.
Weekly Downloads