Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ API Gateway/ Guia de usuário/ Gerenciamento de API/ Importação e exportação de APIs/ Definição estendida/ x-apigateway-auth-type

Atualizado em 2024-10-14 GMT+08:00

Ver PDF

x-apigateway-auth-type

Significado: formato de autenticação apiKey baseado em Swagger, que define um modo de autenticação fornecido pelo APIG.

Escopo do efeito: objeto de esquema de segurança (2.0)/objeto de esquema de segurança (3.0)

Swagger:

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

Exemplo de OpenAPI:

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

**Tabela 1** Descrição do parâmetro
Parâmetro	Obrigatório	Tipo	Descrição
x-apigateway-auth-type	Sim	String	Modo de autenticação usado no APIG. AppSigv1 e IAM são suportados.
type	Sim	String	Tipo de autenticação. Apenas o apiKey é suportado.
name	Sim	String	Nome do parâmetro para autenticação.
in	Sim	String	Apenas o header é suportado.
description	Não	String	Descrição sobre a autenticação.