Basic Auth

From DreamFactory
Jump to: navigation, search

DreamFactory supports Basic HTTP Authentication both via Authorization request header and URL. At a minimum, you should use HTTPS to protect credentials.

API Endpoints

Using Authorization request header

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

Request Header:

 Accept-Encoding:gzip, deflate, sdch
 Authorization:Basic {base64_encode(username + : + password)}    <-- Basic Authentication

Using URL

{METHOD} https://username:[email protected]{url}/api/v2/{service}/{resource}

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

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

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

Example - Basic Authentication via URL using CURL

curl[email protected]/api/v2/db/_table

Note: %40 = url_encode(@)