---
title: "OAuth"
slug: "oauth"
updated: 2024-12-02T13:55:42Z
published: 2024-12-02T13:55:42Z
canonical: "docs.omnisiga.ai/oauth"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omnisiga.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# OAuth

A caixa OAuth é utilizada para o fluxo realizar uma requisição, da mesma maneira que uma caixa REST. Porém, ela armazena os dados necessários para fazer um login OAuth. Para mais informações sobre detalhes de funcionamento/implementação OAuth, consultar a documentação ( [Site oficial OAuth 2](https://oauth.net/2/) ).

![image.png](https://cdn.document360.io/d1786d22-23e4-4145-98ac-accd680324d8/Images/Documentation/image%2829%29.png)

Além dos campos da caixa REST, ela possui um a área para prencher os dados para efetuar o login OAuth no sistema externo.

![image.png](https://cdn.document360.io/d1786d22-23e4-4145-98ac-accd680324d8/Images/Documentation/image%2831%29.png)

### Campos próprios da caixa

![image.png](https://cdn.document360.io/d1786d22-23e4-4145-98ac-accd680324d8/Images/Documentation/image%2830%29.png)

- **Grant Type**  

Tipo de requisição OAuth. Hoje, o sistema aceita os tipos " *Client credencials*" e "*passowrd*".
- **Usuário**  

Campo com o valor do usuário para o login externo OAuth2 (fluxo "*password*").
- **Senha**  

Campo com o valor da senha para o login externo OAuth2 (fluxo "*password*").
- **Client id**  

Campo com o valor do identificador  do cliente para o login externo OAuth2 (para o fluxo "*Client credentials*").
- **Client secret**  

Campo com o valor da do segredo do cliente para o login externo OAuth2 (fluxo "*Client credentials*").
- **URL de autenticação**  

Url que realizará a autenticação do cliente.
- **Scope**  

Escopo do token de autenticação.
- **Variável do token de resposta**  

Caso a opção "Salvar token de resposta" esteja marcada, o campo é habilitado. Cria uma variável de fluxo com o nome informado. Útil para utilizar ao realizar novas requisições Web, sem a necessidade de utilizar a caixa OAuth novamente (quando não há a necessidade de fazer o login novamente).