Skip to main content

authentication-scheme-referenced-by-auth-option

Overview

This rule belongs to the apimatic-preliminary-validation ruleset and states that:

A valid authentication option must reference at least one or more predefined authentication schemes depending on the option type. A single authentication option type can only reference one authentication scheme while a group authentication option can consist of two or more authentication schemes. An option that does not reference any authentication scheme will be considered an invalid authentication option.

PropertyValue
EnabledYes
Maximum SeverityError
MessageAuthentication option does not reference any authentication scheme.
CodeAPIMATICPRE_V071
TypeValidation
Rule SystemSemantic
Broad CategoryAuthentication
Products ImpactedCode Generation, Developer Experience Portal, API Transformer
Tagspreliminary checks validation apimatic authentication option single authentication option group authentication option authentication scheme authentication

Suggested Fixes

  • For single auth option, make sure that the authentication applied is not null or invalid.
  • For group auth option, make sure that the list of authentication schemes that need to be applied is not empty or null or consists of any invalid schemes.