Ir para o conteúdo

HTTP OAuth2

Parâmetros para conexões HTTP usando OAuth 2.0 com credenciais de cliente.

Esta classe estende a conexão HTTP base com credenciais OAuth2 para o fluxo de concessão de credenciais do cliente. Ideal para aplicações que precisam acessar APIs em seu próprio nome, não em nome dos usuários.


Informações Gerais:

Tipo ID Módulo Categoria
5 httplib api

OAuth2ConnectionParams

Parâmetros:

  • client_id: str Identificador do cliente OAuth2 fornecido pelo provedor. Identifica o aplicativo registrado.
  • client_secret: str Segredo do cliente correspondente a client_id. Deve ser mantido altamente confidencial.
  • token_url: HttpUrl URL do endpoint do token do provedor OAuth2 onde ele é solicitado o token de acesso.

Parâmetros de entrada:

Campo Tipo Obrigatório Descrição Valor padrão Exemplos
url HttpUrl URL completo do endpoint de serviço PydanticUndefined https://api.example.com/endpoint
headers Optional[dict[str, str]] Cabeçalhos HTTP adicionais a serem incluídos na solicitação None {"Authorization": "Bearer token", "Content-Type": "application/json"}
method Literal[GET, POST, PUT, DELETE, PATCH] Método HTTP a ser usado GET POST
body Optional[dict[str, Any]] Corpo JSON da solicitação None {"key": "value"}
verify_ssl bool Se deve validar o certificado SSL True True
client_id str Identificador do cliente OAuth2 PydanticUndefined client_id_value
client_secret str Segredo do cliente OAuth2 PydanticUndefined client_secret_value
token_url HttpUrl URL do terminal do token OAuth2 PydanticUndefined https://auth.example.com/token

Exemplo:

{
  "url": "https://api.example.com/oauth2",
  "client_id": "client_id_value",
  "client_secret": "client_secret_value",
  "token_url": "https://auth.example.com/token",
  "headers": {},
  "method": "GET",
  "body": null,
  "verify_ssl": true
}

Notas:

Este modelo oferece suporte ao fluxo de credenciais do cliente OAuth2. O código O uso desses parâmetros deve implementar a solicitação de token ao token_url e seu uso em solicitações subsequentes. Os tokens têm expiração típica, então implemente a atualização automática.