Quando autenticar o usuário com OAuth2, você pode especificar quais dados o token terá acesso através da escolha de um ou mais escopos de acesso.
Escopos
Aqui está a lista de todos os escopos que você pode solicitar:
login | Autenticar com o usuário |
Visualizar o endereço de e-mail | |
profile | Visualizar os dados da conta (nome completo, data de nascimento, cpf, nome dos pais, nível da conta) |
address | Visualizar o endereço completo |
phone | Visualizar o telefone utilizado no cadastro |
banking | Visualizar os dados bancários (agência e conta) |
business | Visualizar os dados da empresa (razão social e cnpj) |
balance | Visualizar o saldo na conta do usuário |
write | Criar e visualizar boletos bancários e clientes |
read | Visualizar boletos bancários, clientes e extrato de transações |
checkout | Visualizar a URL de checkout para pagamentos |
subscription | Visualizar o plano contratado |
OAuth2
Para OAuth2, permissões são acessadas através do parâmetro scope
em sua requisição OAuth2.
Por exemplo, sua aplicação pode precisar logar como o usuário para gerar boletos, porém não precisará saber quais são os dados bancários do usuário.
A permissão padrão é login
caso você não especifice um scope.
Grupo de permissões
Você pode solicitar permissões individuais ou em grupo.
Permissões em grupo devem ser separadas com caracter +
na URL.
Abaixo um exemplo de URL de requisição com parâmetro scope
no final:
https://api-sandbox.kobana.com.br/v1/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_CALLBACK_URL&scope=login+email+profile