Autenticações

Autenticação de Usuário

Refere-se à mesma API de autenticação de usuário consumida pelo portal.

URL

/auth

Methods

POST

Data Params

username

String | Requerido | Identificação do usuário por meio de CPF.

password

String | Requerido | Valor do OTP obtido no aplicativo BirdID.

grant_type

String | Requerido | Informar o valor password

lifetime

Number | Requerido | Valor que indica o tempo de vida desejado para o token a ser gerado em segundos. Não deve ultrapassar (7 dias)

scope

String | Requerido | Informar o valor application_ext

Success Response

Code: 201

{
    "access_token": "5febf3bc80a6615ad2fecbcae61670bf9e123a98",
    "token_type": "bearer",
    "provider_environment": "bird",
    "corporations": [
        {
            "id": 9,
            "name": "Corporação Teste Ltda.",
            "cnpj": "33837169000150"
        }
    ],
    "roles": [
        "user"
    ],
    "_links": {
        "self": {
            "href": "https://billing.hom.vaultid.com.br/auth"
        }
    }
}

Error Response

Code: 400 Content: 

{
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "invalid_grant",
    "status": 400,
    "detail": {
        "code": 1056,
        "status": "INVALID_CREDENTIALS",
        "message": "Invalid credentials"
    }
}

Exemplo

curl --location 'https://billing.hom.vaultid.com.br/auth' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "username": "83164833865",
    "password": "696439",
    "grant_type": "password",
    "scope": "application_ext",
    "lifetime": 86400
}'

Ambientes

PreviousWingsNextConsultar Usuários

Last updated