Defining a security scheme compatible with AWS API Gateway | Talend Cloud API Designer User Guide Help
Skip to main content Skip to complementary content

Defining a security scheme compatible with AWS API Gateway

When exporting a definition from Talend Cloud API Designer and importing it into AWS API Gateway, your security can be propagated if it is defined properly.

Procedure

  1. Open your API and go to the general information page.
  2. Go to the Security schemes section and click Add.
  3. Enter a name.
  4. In the Type drop-down list, select Custom / API key.
  5. Click Add header in the Headers section.
  6. In the Name field, enter x-api-key.
  7. In the Type field, select string.
  8. Click Add.

Results

You have defined a security scheme which is compatible with AWS API Gateway. You can use it globally or on the resource or operation level.
Security scheme example called AWS API Gateway, with the type Custom / API key and a string header.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!