README

Akamai EdgeGrid Authentication for PHP

This library requires PHP 8.2+ and implements the Akamai EdgeGrid Authentication scheme for PHP.

Install

To install, use composer:

$ composer require akamai-open/edgegrid-auth

Alternative installation methods

Single file (PHAR)

Download the PHAR file from the releases page and include it inside your code:

include 'akamai-open-edgegrid-auth.phar';

// Library is ready to use

Clone or download

1. Either clone or download to pull down a copy of this repository.

   • Clone the repository using git or subversion.
   • Download the latest ZIP archive or specific release ZIP archive.

2. Use the composer autoloader and install the dependencies.

   $ composer install

3. Include the autoloader.

   require_once 'vendor/autoload.php';

   If you don't use the autoloader, manually include all the required classes in your code.

   require_once 'src/Authentication.php';
   require_once 'src/Authentication/Timestamp.php';
   require_once 'src/Authentication/Nonce.php';
   require_once 'src/Authentication/Exception.php';
   require_once 'src/Authentication/Exception/ConfigException.php';
   require_once 'src/Authentication/Exception/SignerException.php';
   require_once 'src/Authentication/Exception/SignerException/InvalidSignDataException.php';

Authentication

You can obtain the authentication credentials through an API client. Requests to the API are marked with a timestamp and a signature and are executed immediately.

1. Create authentication credentials.

2. Place your credentials in an EdgeGrid resource file ~/.edgerc, in the [default] section.

   [default]
   client_secret = C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=
   host = akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net
   access_token = akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij
   client_token = akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj
   

3. Use your local .edgerc by providing the credentials section header and the path to your resource file. You can call your .edgerc file using the \Akamai\Open\EdgeGrid\Authentication::createFromEdgeRcFile() method.

   The location of your .edgerc file is optional, as it defaults to ~/.edgerc.

   $auth = \Akamai\Open\EdgeGrid\Authentication::createFromEdgeRcFile('default', '~/.edgerc');

   Alternatively, you can hard code your credentials.

   $auth = \Akamai\Open\EdgeGrid\Authentication([
   'base_uri' => 'https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net'
   ]);
   $auth-> setHost('https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net');
   
   $client_token = 'akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj';
   $client_secret = 'C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=';
   $access_token = 'akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij';
   
   $auth-> setAuth($client_token, $client_secret, $access_token);

Use

Once you have installed the library, you can create the header value by calling the appropriate \Akamai\Open\Edgegrid\Authentication::set*() methods.

For example, using it with the built-in streams HTTP client might look like the following:

<?php
require "vendor/autoload.php";

$auth = \Akamai\Open\EdgeGrid\Authentication::createFromEdgeRcFile('default', '~/.edgerc');
$auth->setHttpMethod('GET');
$auth->setPath('/identity-management/v3/user-profile');

$context = array(
  'http' => array(
    'header' => array(
      'Authorization: ' . $auth->createAuthHeader(),
      'Content-Type: application/json'
    )
  )
);

$context = stream_context_create($context);

$response = json_decode(file_get_contents('https://' . $auth->getHost() . $auth->getPath(), null, $context));

License

Copyright © 2026 Akamai Technologies, Inc. All rights reserved

Licensed under the Apache License, Version 2.0 (the "License"); you may not use these files except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.