Skip to content

Basic Authentication

As of Adaptix 2.3.0, support for basic authentication can be enabled through Adaptix's Configuration -> API Settings. As with OAuth2, it is only recommended to use basic authentication over HTTPS.

To authorize a request for basic authentication, set an Authorization header.

  • Combine the username and password of a Adaptix user with a colon :. For example, user:password.
  • Base64 encode the string from above. dXNlcjpwYXNzd29yZA==.
  • Add an Authorization header to each API request as Authorization: Basic dXNlcjpwYXNzd29yZA==
  • The URL should be a known endopoint i.e. api/contacts

CURL Sample,

1
curl -H "Authorization: Basic $(echo -n 'username:password' | base64)" https://instancename.adaptix.ai/api/contacts

PHP Sample

$settings will be an array like this:

1
2
3
4
5
6
<?php
// ApiAuth->newAuth() will accept an array of Auth settings
$settings = [
    'userName'   => '',             // Create a new user       
    'password'   => '',             // Make it a secure password
];

Also, for basic auth, pass 'BasicAuth' in 2nd parameter: 

1
2
3
// Initiate the auth object
$initAuth = new ApiAuth();
$auth     = $initAuth->newAuth($settings, 'BasicAuth');