Basic Auth

Revision as of 21:27, 14 October 2015

1. 1. 1. Tutorial

DreamFactory 2.0 supports Basic HTTP Authentication both via Authorization request header and URL.

1. 1. 1. API Endpoints

1. 1. 1. 1. Using Authorization request header

{METHOD} https://{url}/api/v2/{service}/{resource}

Request Header:

 Accept:application/json
 Accept-Encoding:gzip, deflate, sdch
 Accept-Language:en-US,en;q=0.8
 Authorization:Basic {base64_encode(username + : + password)}    <-- Basic Authentication
 Connection:keep-alive
 Content-Type:application/json
 ....

1. 1. 1. 1. Using URL

{METHOD} https://username:password@{url}/api/v2/{service}/{resource}

> _Note: Basic Authentication over URL will not work for user agents that support request header (most web browsers)_

1. 1. 1. Example - Basic Authentication via Authorization request header using JQuery Ajax call

var username = $('#username').val();
var password = $('#password').val();
var url = $('#url').val();
 
$.ajax({ 
    url: url,
    async: true,
    type:'GET',
    dataType: 'json',
    contentType: 'application/json',
    beforeSend: function(xhr) {
        xhr.setRequestHeader("Authorization", "Basic "+btoa(username+':'+password));
    },
    success: function(json){
        ...
    },
    error: function(err) {
        ...
    }
});

1. 1. 1. Example - Basic Authentication via URL using CURL

• Username: jdoe@dreamfactory.com
• Password: secret
• Service: system
• Resource: user

curl http://jdoe%40dreamfactory.com:secret@foo.com/rest/system/user

> _Note: %40 = url_encode(@)_