Skip to content

Misleading / Incorrect Documentation #3

Description

@jesterhuizen

Description

In the Getting Started section of the README.md the example code makes use of the following line for authentication configuration

configuration.api_key['apiKeyAuth'] = "<API_KEY_PLACEHOLDER>"

This does not work with the scan request failing with the following error

{"statusCode":401,"code":"FST_BEARER_AUTH_MISSING_AUTHORIZATION_HEADER","error":"Unauthorized","message":"missing authorization header"}

The correct configuration for users who self-host, is in the next section Configure SDK (self-hosted on AWS) where the line changes to

configuration.access_token = "<API_KEY_PLACEHOLDER>"

which is able to successfully call the api.

Solution
Update the README.md and add the correct syntax/code example for the self-hosted option in the Getting Started section.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions