Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Objetivo

Método que exibe as informações de login para acesso ao Corp, com o token e o token de atualização.

Chamada

POST api/v1/auth/corp/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)

groupIdIdentificador do grupo de usuário.stringObrigatório
usernameNome ou e-mail do usuário para acessar os sistemas TOTVS Varejo Supermercados (Linha Consinco)stringObrigatório. Tipo de dado: endereço de email.
passwordSenha do Usuário.string

Obrigatório. Tipo de dado: senha

Formatos da Requisição (Request Formats)

application/json, text/json
Bloco de código
languageactionscript3
{
  "groupId": 1,
  "username": "sample string 2",
  "password": "sample string 3"
}

application/xml, text/xml

Bloco de código
languageactionscript3
<ConsincoUserCorpBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AuthenticationServer.Models">
  <ControllerVersion>4</ControllerVersion>
  <GroupId>1</GroupId>
  <Password>sample string 3</Password>
  <Username>sample string 2</Username>
</ConsincoUserCorpBindingModel>

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)
  • Unauthorized (401)
  • InternalServerError (500)

Descrição dos Recursos

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information)

access_tokenToken de acesso.

string

Não há.
token_typeTipo do token.stringNão há.
expires_inTempo de expiração.stringNão há.
refresh_tokenToken de atualização.stringNão há.
usernameNome/Email do usuário.stringNão há.
idCódigo sequencial do usuário.integerNão há.
nameNome de login do usuário.stringNão há.
userSequenceCódigo sequencial do usuário.integerNão há.
userCodeNome de login do usuário.stringNão há.
permissionRoleTipos de permissões.stringNão há.
companyNome da empresa.stringNão há.
companyTypeTipo da empresa.stringNão há.
isExtIndica se é um usuário externo.booleanNão há.
loginIdNome de login do usuário.stringNão há.
.issuedData e hora do logindateNão há.
.expiresData e horário de expiração do token.dateNão há.

Formatos de Resposta (Response Formats)

application/json, text/json
Bloco de código
languageactionscript3
{
  "<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",
  "<userSequence>k__BackingField": 8,
  "<email>k__BackingField": "sample string 9",
  "<permissionRole>k__BackingField": "sample string 10",
  "<group>k__BackingField": "sample string 11",
  "<groupId>k__BackingField": "sample string 12",
  "<issued>k__BackingField": "2021-01-28T13:43:49.8049073-03:00",
  "<expires>k__BackingField": "2021-01-28T13:43:49.8049073-03:00",
  "<isExt>k__BackingField": true
}

application/xml, text/xml

Bloco de código
languageactionscript3
<TokenCorpResponse 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_email_x003E_k__BackingField>sample string 9</_x003C_email_x003E_k__BackingField>
  <_x003C_expiresIn_x003E_k__BackingField>sample string 3</_x003C_expiresIn_x003E_k__BackingField>
  <_x003C_expires_x003E_k__BackingField>2021-01-28T13:43:49.8049073-03:00</_x003C_expires_x003E_k__BackingField>
  <_x003C_groupId_x003E_k__BackingField>sample string 12</_x003C_groupId_x003E_k__BackingField>
  <_x003C_group_x003E_k__BackingField>sample string 11</_x003C_group_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-28T13:43:49.8049073-03:00</_x003C_issued_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_tokenType_x003E_k__BackingField>sample string 2</_x003C_tokenType_x003E_k__BackingField>
  <_x003C_userName_x003E_k__BackingField>sample string 5</_x003C_userName_x003E_k__BackingField>
  <_x003C_userSequence_x003E_k__BackingField>8</_x003C_userSequence_x003E_k__BackingField>
</TokenCorpResponse>