Ensure api managers can disable API key check on Backends #622

kyyberi · 2015-11-11T16:48:42Z

Original report (by @kyyberi)

Even if I selected that API key is optional (and also selected unlimited requests), when testing the API response was:
API_KEY_MISSING

Definition of done (by @bajiat, by @brylie modified due to Multiproxy work)

Make sure the disable api key field in added to and stored in Proxy backend collection
Make sure the properties of the field are aligned with Api Umbrella
Make sure the field is passed correctly to the Admin REST API
Make sure it gets stored properly in API Umbrella
There needs to be setting in the Proxy tab in API profile

Wireframe

The text was updated successfully, but these errors were encountered:

kyyberi · 2015-11-11T16:49:12Z

Works with api_key parameter though

bajiat · 2015-11-19T11:58:54Z

@kyyberi To what server are you making the request? Specifically, are you making the request to Api Umbrella server? If that is the case, this is an upstream bug.

kyyberi · 2015-11-19T22:37:39Z

I'm using API managed by APIKA, but obviously the actual API calls go through Umbrella. In those cases, api_key is always required. References API is Lentodiilit REST API

bajiat · 2016-01-12T09:10:38Z

@brylie Should we check the Edit API backend form that the data gets passed correctly?

brylie · 2016-01-12T10:27:25Z

@bajiat jep. Specifically, we need to make sure the configuration object sent to API Umbrella conforms to the REST API request requirements:

{
  "api": {
    "id": "string",
    "name": "string",
    "sort_order": 0,
    "backend_protocol": "http",
    "frontend_host": "string",
    "backend_host": "string",
    "servers": [
      {
        "id": "string",
        "host": "string",
        "port": 0
      }
    ],
    "url_matches": [
      {
        "id": "string",
        "frontend_prefix": "string",
        "backend_prefix": "string"
      }
    ],
    "balance_algorithm": "least_conn",
    "settings": {
      "id": "string",
      "append_query_string": "string",
      "headers": [
        {
          "id": "string",
          "key": "string",
          "value": "string"
        }
      ],
      "headers_string": "string",
      "default_response_headers": [
        {
          "id": "string",
          "key": "string",
          "value": "string"
        }
      ],
      "default_response_headers_string": "string",
      "override_response_headers": [
        {
          "id": "string",
          "key": "string",
          "value": "string"
        }
      ],
      "override_response_headers_string": "string",
      "http_basic_auth": "string",
      "require_https": "required_return_error",
      "require_https_transition_start_at": "2016-01-12T09:23:24.660Z",
      "disable_api_key": true,
      "api_key_verification_level": "none",
      "api_key_verification_transition_start_at": "2016-01-12T09:23:24.660Z",
      "required_roles": [
        "string"
      ],
      "required_roles_override": true,
      "allowed_ips": [
        "string"
      ],
      "allowed_referers": [
        "string"
      ],
      "rate_limit_mode": "unlimited",
      "rate_limits": [
        {
          "id": "string",
          "duration": 0,
          "accuracy": 0,
          "limit_by": "ip",
          "distributed": true,
          "response_headers": true
        }
      ],
      "anonymous_rate_limit_behavior": "ip_fallback",
      "authenticated_rate_limit_behavior": "all",
      "pass_api_key_header": true,
      "pass_api_key_query_param": true,
      "error_templates": {},
      "error_data": {},
      "error_data_yaml_strings": {}
    },
    "sub_settings": [
      {
        "id": "string",
        "http_method": "any",
        "regex": "string",
        "settings": {
          "id": "string",
          "append_query_string": "string",
          "headers": [
            {
              "id": "string",
              "key": "string",
              "value": "string"
            }
          ],
          "headers_string": "string",
          "default_response_headers": [
            {
              "id": "string",
              "key": "string",
              "value": "string"
            }
          ],
          "default_response_headers_string": "string",
          "override_response_headers": [
            {
              "id": "string",
              "key": "string",
              "value": "string"
            }
          ],
          "override_response_headers_string": "string",
          "http_basic_auth": "string",
          "require_https": "required_return_error",
          "require_https_transition_start_at": "2016-01-12T09:23:24.663Z",
          "disable_api_key": true,
          "api_key_verification_level": "none",
          "api_key_verification_transition_start_at": "2016-01-12T09:23:24.663Z",
          "required_roles": [
            "string"
          ],
          "required_roles_override": true,
          "allowed_ips": [
            "string"
          ],
          "allowed_referers": [
            "string"
          ],
          "rate_limit_mode": "unlimited",
          "rate_limits": [
            {
              "id": "string",
              "duration": 0,
              "accuracy": 0,
              "limit_by": "ip",
              "distributed": true,
              "response_headers": true
            }
          ],
          "anonymous_rate_limit_behavior": "ip_fallback",
          "authenticated_rate_limit_behavior": "all",
          "pass_api_key_header": true,
          "pass_api_key_query_param": true,
          "error_templates": {},
          "error_data": {},
          "error_data_yaml_strings": {}
        }
      }
    ],
    "rewrites": [
      {
        "id": "string",
        "matcher_type": "route",
        "http_method": "any",
        "frontend_matcher": "string",
        "backend_replacement": "string"
      }
    ],
    "created_at": "2016-01-12T09:23:24.665Z",
    "creator": {
      "username": "string"
    },
    "updated_at": "2016-01-12T09:23:24.666Z",
    "updater": {
      "username": "string"
    }
  }
}

brylie · 2016-01-12T10:29:25Z

I think there are two possible candidate fields in the above configuration:

...
"disable_api_key": true,
"api_key_verification_level": "none",

kyyberi · 2016-01-12T15:23:05Z

"disable_api_key": true is more self explanatory

brylie · 2016-01-13T10:23:25Z

Right, this is API Umbrella functionality though. So, we need to figure out which field(s) API Umbrella uses to control the API Key requirement.

brylie · 2016-01-13T10:24:25Z

As @kyyberi indicates, lets test the disable_api_key first, and issue a fix if that is the correct setting.

brylie · 2016-05-06T13:06:32Z

When submitting our Edit API Backend form, the 'disable api key' field data is not being updated on API Umbrella. We need to make sure our integration code is passing the updates to all API Backend configuration fields.
Related to issue #833

brylie · 2016-05-20T08:52:01Z

Copied from #833:

We have a field on the "Edit API Backend" form to toggle the API Key check, but the changes are not made on API Umbrella. We need to make sure our integration code is passing the updates to all API Backend configuration fields.

Nazarah · 2016-09-01T11:21:50Z

@NNN what are your ideas about how the interface should look? please let me know.

Nazarah · 2016-09-07T11:12:36Z

@NNN : I've added the wireframes. One is the checkbox you suggested and another is toggling option. Please review them and give your feedback.
Suggestions for the text is also welcomed.

P.S. I;ve added only the field for this task only, As there might be other fields in the proxy tab, but the UI is not yet ready, you can place this field where convenient.

55 · 2016-09-07T11:28:32Z

I like with simple checkbox, let's go with it.

bajiat · 2016-09-14T08:33:41Z

@NNN What is the status?

kyyberi added bug APIKA labels Nov 11, 2015

bajiat added the upstream label Nov 19, 2015

brylie changed the title ~~API key forced~~ Ensure api managers can disable API key check on Backends Jan 12, 2016

brylie mentioned this issue May 6, 2016

Possibility to call APIs without API Key #833

Closed

brylie added help wanted and removed upstream labels May 6, 2016

brylie added the planning label May 20, 2016

bajiat added the Customer's wish label May 20, 2016

bajiat assigned jykae May 23, 2016

bajiat added ready and removed planning labels May 23, 2016

bajiat added this to the Sprint 23 milestone May 23, 2016

bajiat assigned 55 and unassigned jykae May 26, 2016

bajiat added in progress and removed ready labels May 26, 2016

bajiat added API Backend and removed in progress labels Jun 3, 2016

bajiat unassigned jykae and 55 Aug 24, 2016

bajiat added Multi-proxy wireframe needed planning blocked and removed backlog labels Aug 24, 2016

Nazarah mentioned this issue Aug 29, 2016

wireframe to Ensure api managers can disable API key check on Backends #1453

Closed

55 self-assigned this Aug 30, 2016

55 added ready and removed blocked planning labels Aug 30, 2016

brylie removed bug testing labels Sep 7, 2016

Nazarah added wireframe available and removed wireframe needed labels Sep 7, 2016

55 added in progress and removed ready labels Sep 7, 2016

55 mentioned this issue Sep 9, 2016

Feature/disable apikey #1518

Merged

55 added this to the Sprint 30 milestone Sep 9, 2016

55 added blocked and removed in progress blocked labels Sep 14, 2016

bajiat added the in progress label Sep 19, 2016

brylie closed this as completed in #1518 Sep 21, 2016

brylie removed the in progress label Sep 21, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ensure api managers can disable API key check on Backends #622

Ensure api managers can disable API key check on Backends #622

kyyberi commented Nov 11, 2015 •

edited by Nazarah

kyyberi commented Nov 11, 2015

bajiat commented Nov 19, 2015

kyyberi commented Nov 19, 2015

bajiat commented Jan 12, 2016

brylie commented Jan 12, 2016

brylie commented Jan 12, 2016

kyyberi commented Jan 12, 2016

brylie commented Jan 13, 2016

brylie commented Jan 13, 2016

brylie commented May 6, 2016

brylie commented May 20, 2016

Nazarah commented Sep 1, 2016

Nazarah commented Sep 7, 2016

55 commented Sep 7, 2016

bajiat commented Sep 14, 2016

Ensure api managers can disable API key check on Backends #622

Ensure api managers can disable API key check on Backends #622

Comments

kyyberi commented Nov 11, 2015 • edited by Nazarah

Original report (by @kyyberi)

Definition of done (by @bajiat, by @brylie modified due to Multiproxy work)

Wireframe

kyyberi commented Nov 11, 2015

bajiat commented Nov 19, 2015

kyyberi commented Nov 19, 2015

bajiat commented Jan 12, 2016

brylie commented Jan 12, 2016

brylie commented Jan 12, 2016

kyyberi commented Jan 12, 2016

brylie commented Jan 13, 2016

brylie commented Jan 13, 2016

brylie commented May 6, 2016

brylie commented May 20, 2016

Nazarah commented Sep 1, 2016

Nazarah commented Sep 7, 2016

55 commented Sep 7, 2016

bajiat commented Sep 14, 2016

kyyberi commented Nov 11, 2015 •

edited by Nazarah