Skip to content

Securing Gloop APIs

By adding authentication to your Gloop APIs, you can limit their availability to certain users or groups. In order to add security to a certain Gloop API, be it SOAP or REST, simply follow the steps below:

  1. Open the Gloop API Editor by double clicking on the target .api file from the Coder Cloud Nagivator view.
  2. Go to the Security tab of the editor.
  3. Choose your authentication scheme(s) by ticking any of the values under Authentication Type. The choices are:

    • None

      By default, your Gloop API has no authentication scheme set. This means that everybody can access your API and thus, you cannot specify a permitted Integrate User or Integrate Group as that won't make much sense. If there are existing permitted Integrate Users or Groups added to the API, the API will ignore them.

    • Basic

    • OAuth 2.0

    api.basic.auth must be set to true to make Basic authentication work

    The property api.basic.auth in your application .properties file should have a value of true or else, Basic authentication will not work. Changing this value during runtime will require an instance restart.

    1
    api.basic.auth=true
    
  4. Add an Integrate User or Integrate Group.

    When Basic, OAuth 2.0, or both authentication schemes are selected, you may add an Integrate User or Group by hitting the corresponding + button. Doing so would show either the Select User Dialog or the Select Group Dialog. From this pop-up, you can proceed to selecting to whom the API is exposed to.

    Configuring users and groups

    For managing Integrate Users or Integrate Groups, see Managing Users and Groups.

  5. Save the changes by clicking on the save button or by pressing Command.

    [start-toggler] How to secure a Gloop API in Coder Studio ![[Coder Studio]] How to secure a Gloop API in Coder Cloud ![[Coder Cloud]] [end-toggler]