Objetivo

Método que exibe as informações de login, como o token de acesso.

Chamada

POST api/v1/auth/login

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
companyEmpresa que o usuário pertence.stringObrigatório
usernameNome do usuário para acessar os sistemas TOTVS Varejo Supermercados.stringNão há.
passwordSenha do Usuário.string

Tipo de dado: senha

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Descrição dos Recursos

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
access_token

string

Não há.
token_type
stringNão há.
expires_in
stringNão há.
refresh_token
stringNão há.
username
stringNão há.
id
integerNão há.
name
stringNão há.
userSequence
integerNão há.
userCode
stringNão há.
permissionRole
stringNão há.
company
stringNão há.
companyType
stringNão há.
isExt
booleanNão há.
loginId
stringNão há.
.issued
dateNão há.
.expires
dateNão há.

Formatos de Resposta (Response Formats)

application/json, text/json
{
  "<accessToken>k__BackingField": "sample string 1",
  "<tokenType>k__BackingField": "sample string 2",
  "<expiresIn>k__BackingField": "sample string 3",
  "<refreshToken>k__BackingField": "sample string 4",
  "<userName>k__BackingField": "sample string 5",
  "<id>k__BackingField": 6,
  "<name>k__BackingField": "sample string 7",
  "<seqUser>k__BackingField": 8,
  "<userCode>k__BackingField": "sample string 9",
  "<permissionRole>k__BackingField": "sample string 10",
  "<company>k__BackingField": "sample string 11",
  "<companyType>k__BackingField": "sample string 12",
  "<isExt>k__BackingField": true,
  "<loginId>k__BackingField": "sample string 14",
  "<issued>k__BackingField": "2021-01-28T10:05:07.4957031-03:00",
  "<expires>k__BackingField": "2021-01-28T10:05:07.4957031-03:00"
}

application/xml, text/xml

<TokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Kike.Security.Data.Dto">
  <_x003C_accessToken_x003E_k__BackingField>sample string 1</_x003C_accessToken_x003E_k__BackingField>
  <_x003C_companyType_x003E_k__BackingField>sample string 12</_x003C_companyType_x003E_k__BackingField>
  <_x003C_company_x003E_k__BackingField>sample string 11</_x003C_company_x003E_k__BackingField>
  <_x003C_expiresIn_x003E_k__BackingField>sample string 3</_x003C_expiresIn_x003E_k__BackingField>
  <_x003C_expires_x003E_k__BackingField>2021-01-28T10:05:07.4957031-03:00</_x003C_expires_x003E_k__BackingField>
  <_x003C_id_x003E_k__BackingField>6</_x003C_id_x003E_k__BackingField>
  <_x003C_isExt_x003E_k__BackingField>true</_x003C_isExt_x003E_k__BackingField>
  <_x003C_issued_x003E_k__BackingField>2021-01-28T10:05:07.4957031-03:00</_x003C_issued_x003E_k__BackingField>
  <_x003C_loginId_x003E_k__BackingField>sample string 14</_x003C_loginId_x003E_k__BackingField>
  <_x003C_name_x003E_k__BackingField>sample string 7</_x003C_name_x003E_k__BackingField>
  <_x003C_permissionRole_x003E_k__BackingField>sample string 10</_x003C_permissionRole_x003E_k__BackingField>
  <_x003C_refreshToken_x003E_k__BackingField>sample string 4</_x003C_refreshToken_x003E_k__BackingField>
  <_x003C_seqUser_x003E_k__BackingField>8</_x003C_seqUser_x003E_k__BackingField>
  <_x003C_tokenType_x003E_k__BackingField>sample string 2</_x003C_tokenType_x003E_k__BackingField>
  <_x003C_userCode_x003E_k__BackingField>sample string 9</_x003C_userCode_x003E_k__BackingField>
  <_x003C_userName_x003E_k__BackingField>sample string 5</_x003C_userName_x003E_k__BackingField>
</TokenResponse>