x-apigateway-auth-opt

Meaning: App (simple authentication) parameter

Scope of effect: Security Scheme Object (2.0)/Security Scheme Object (3.0)

Swagger example:

securityDefinitions:
  apig-auth-app:
    type: apiKey
    name: Authorization
    in: header
    x-apigateway-auth-type: AppSigv1
  apig-auth-app-header:
    type: apiKey
    name: Authorization
    in: header
    x-apigateway-auth-opt:
      appcode-auth-type: header
    x-apigateway-auth-type: AppSigv1
  apig-auth-iam:
    type: apiKey
    name: unused
    in: header
    x-apigateway-auth-type: IAM

OpenAPI example:

securitySchemes:
    apig-auth-app:
      in: header
      name: Authorization
      type: apiKey
      x-apigateway-auth-type: AppSigv1
    apig-auth-app-header:
      in: header
      name: Authorization
      type: apiKey
      x-apigateway-auth-opt:
        appcode-auth-type: header
      x-apigateway-auth-type: AppSigv1
    apig-auth-iam:
      in: header
      name: unused
      type: apiKey
      x-apigateway-auth-type: IAM

Table 1 Parameter description
Parameter	Mandatory	Type	Description
appcode-auth-type	No	String	Indicates whether AppCode authentication is enabled. The default value is disable. disable: AppCode authentication is disabled. header: AppCode authentication is enabled and the AppCode is located in the header.

Parent topic: API Design File Extension Definitions

Предыдущая статья

x-apigateway-plugins

Следующая статья

x-apigateway-result-normal-sample

Была ли эта статья полезна?

Поддержка Юридические документы