Authenticação

Funcionamento da rota que permite a criação de uma sessão na Web API

Este endpoint não exige um token de Identificação das Credenciais, pois ele é usado para conseguir o mesmo.

Confira mais detalhes sobre a parte de segurança em Segurança.

Recuperar Credenciais

POST https://api.cyberlabs.ai/rest/api/v1/auth/sign-in

Recuperação das credenciais de acesso de um usuário.

Headers

Name	Type	Description
authorization	string	O token de autorização que é gerado com base no no Client ID e Secret ID e fornecido pela Cyberlabs.

Request Body

Name	Type	Description
username	string	Conta que irá criar a sessão.
password	string	Senha do usuário que irá criar a sessão.

200 Uma nova sessão foi criada para ter acesso à API. A propriedade token terá o token que poderá ser usado, o status terá o valor true e a mensagem detalhes do processamento.

{
  "user": {
    "permission": Array<Permission>,
    "id": string,
    "name": string,
    "email": string,
    "username": string,
    "deleted": boolean,
    "created": Datetime
  },
  "token": string,
  "status": boolean,
  "message": string
}

As mensagens de erro seguem um mesmo padrão e estão listadas em Tratamento de Erros

Exemplos

Raw HTTP

POST https://api.cyberlabs.ai/rest/api/v1/auth/sign-in
Content-Type: application/json
Authorization: insight Q0wtRkZLWFhKSTY3VEJSNlozU0RINjI2N1NENTRKUUpKVkw6Q1MtUVpOTTJXWU5JUTJUSTNMSzNUWUZDQVVST1gyRElNVk8=

{
  "username": "john.doe",
  "password": "secret"
}

###

cURL

curl -H "Content-Type: application/json"\
 -H "Authorization: insight Q0ktcGxHTVVTbGIzb21yVFNOUWtGdkk4b1ZzWkxlMndXNEk6Q1MtQ1hwRWJ2azg3Zm0xMEhrTnNwamV5Q2ZXUWtZd21ON0s="\
 -d '{"username": "garm","password": "cyberlabs123"}'\
 -X POST "https://api.cyberlabs.ai/rest/api/v1/auth/sign-in"