POST

api/genericos/ge/OAuth/RefreshOAuthToken

Notas de Implementação:

Método para atualizar as informações do token de autenticação OAuth.

Informações de Envio:

Cabeçalhos de Envio:

Parâmetro Valor Descrição Tipo de parâmetro Tipo de dados
Authorization Bearer Hash gerado no login Header String

Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar

Modelo:

DTO contendo as informações do token a ser atualizado.

ClientTokenDTO

NomeDescriçãoTipoInformação Adicional
AccessToken

Token de acesso.

 string

Obrigatório
RefreshToken

Token para realizar o refresh do AccessToken.

 string

Obrigatório
OwnerToken

E-mail vinculado ao token.

 string

Obrigatório
ExpiresIn

Tempo de expiração do token.

 string

Obrigatório
CreationDate

Data de criação do token.

 date

Obrigatório
CreationHour

Hora de criação do token.

 string

Obrigatório

Formato: HH:MM:SS
Expired

Define se o token está expirado.

 boolean

Opcional
TokenType

Tipo do token.

 string

Opcional
Usuario

Usuário para a busca de configurações do CIGAM. Ao passar essa propriedade como branco será utilizado o usuário logado na API.

 string

Obrigatório

Formato de Envio:

application/json, text/json

Exemplo: 
{
  "AccessToken": "string 1",
  "RefreshToken": "string 2",
  "OwnerToken": "string 3",
  "ExpiresIn": "string 4",
  "CreationDate": "2026-01-13",
  "CreationHour": "string 6",
  "Expired": true,
  "TokenType": "string 8",
  "Usuario": "string 9"
}

Informações de Retorno:

Cabeçalhos Adicionais:

Nome Descrição Valor
cigam-api-version Versão do build/compilação dessa versão da API 2.1.8565.21067

Modelo:

HttpCustomResponse

NomeDescriçãoTipoInformação Adicional
success

boolean

Opcional
hash

string

Opcional
messages

string

Opcional
data

Object

Opcional
tipoLogin

string

Opcional

Formato de Resposta:

Retorna as informações do token atualizado.

Código de status HTTP Descrição Modelo de resposta
200 OK

application/json, text/json

Exemplo: 
{
  "success": true,
  "hash": "string 2",
  "messages": [
    "string 1"
  ],
  "data": {},
  "tipoLogin": "string 4"
}
400 Requisição inválida

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
401 Não autorizado

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
500 Requisição falhou

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
502 Falha de comunicação

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}