akamai-open
EdgeGrid for Node.js
This library implements an Authentication handler for the Akamai EdgeGrid Authentication scheme in Node.js for Node v20 and higher LTS versions.
You can find the most up-to-date package in NPM under akamai-edgegrid.
Install
npm install --save akamai-edgegrid
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.
Place your credentials in an EdgeGrid 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-yvsdjUse your local
.edgercby providing the path to your resource file and credentials' section header.var eg = new EdgeGrid({ path: '/path/to/.edgerc', section: '<section-header>' });Alternatively, you can hard code your credentials by passing the credential values to the
EdgeGrid()method.var clientToken = "akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj", clientSecret = "C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=", accessToken = "akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij", baseUri = "akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net"; var eg = new EdgeGrid(clientToken, clientSecret, accessToken, baseUri);
Use
To use the library, provide the path to your .edgerc, your credentials section header, and the appropriate endpoint information.
var EdgeGrid = require('akamai-edgegrid');
var eg = new EdgeGrid({
path: '/path/to/.edgerc',
section: 'section-header'
});
eg.auth({
path: '/identity-management/v3/user-profile',
method: 'GET',
headers: {
'Accept': "application/json"
},
body: {}
});
eg.send(function(error, response, body) {
console.log(body);
});Chaining
You can also chain calls by combining the execution of auth and send methods.
eg.auth({
path: '/identity-management/v3/user-profile',
method: 'GET',
headers: {},
body: {}
}).send(function (error, response, body) {
console.log(body);
});Query string parameters
When entering query parameters use the qs property under the auth method. Set up the parameters as name-value pairs in a object.
eg.auth({
path: '/identity-management/v3/user-profile',
method: 'GET',
headers: {},
qs: {
authGrants: true,
notifications: true,
actions: true
},
body: {}
})Headers
Enter request headers as name-value pairs in an object.
Note: You don't need to include the
Content-TypeandContent-Lengthheaders. The authentication layer adds these values.
eg.auth({
path: '/identity-management/v3/user-profile',
method: 'GET',
headers: {
'Accept': "application/json"
}
});Body data
Provide the request body as an object or as a POST data formatted string.
// Object
eg.auth({
path: '/identity-management/v3/user-profile/basic-info',
method: 'PUT',
headers: {},
body: {
contactType: "Billing",
country: "USA",
firstName: "John",
lastName: "Smith",
phone: "3456788765",
preferredLanguage: "English",
sessionTimeOut: 30,
timeZone: "GMT"
}
});Encoding
When interacting with binary data, such as during the retrieval of PDF invoices, specify the responseType as an arraybuffer in the auth method call. Omitting the responseType will cause an unreadable or blank response.
const fs = require('fs');
eg.auth({
path : `/invoicing-api/v2/contracts/${contractId}/invoices/${invoiceNumber}/files/${fileName}`,
method: 'GET',
responseType: 'arraybuffer', // Important
}).send((err, response) => {
if (err) {
return console.log(err);
}
fs.writeFile(`./${fileName}`, response.data, 'binary', (err) => {
if (err){
return console.log(err);
}
console.log('File was saved!');
});
});Logging
The library supports configurable logging through the enableLogging() method.
enableLogging()Enable with Environment Variables:
AKAMAI_LOG_LEVEL(Default: 'info')- Valid values:
- 'error'
- 'warn'
- 'info'
- 'debug'
- 'fatal'
- 'trace'
- Valid values:
AKAMAI_LOG_PRETTY(Default: 'false')- Valid values: 'true' or 'false'
const edgeGrid = require('akamai-edgegrid');
// Set environment variables before enabling
process.env.AKAMAI_LOG_LEVEL = 'debug';
process.env.AKAMAI_LOG_PRETTY = 'true';
var eg = new EdgeGrid({
path: '/path/to/.edgerc',
section: '<section-header>'
});
eg.enableLogging(true);Disable Logging:
const edgeGrid = require('akamai-edgegrid'); var eg = new EdgeGrid({ path: '/path/to/.edgerc', section: '<section-header>' }); eg.enableLogging(false);Custom Logger:
- You can also pass a custom logger object to enableLogging. The object must have info, debug, error and warn methods.
- If you pass an object that does not implement the required info, debug, error and warn methods, an error will be thrown.
const edgeGrid = require('akamai-edgegrid');
//custom logger
const logger = {
info: (msg, ...args) => console.log('INFO:', msg, ...args),
debug: (msg, ...args) => console.log('DEBUG:', msg, ...args),
error: (msg, ...args) => console.error('ERROR:', msg, ...args),
warn: (msg, ...args) => console.warn('WARN:', msg, ...args)
};
var eg = new EdgeGrid({
path: '/path/to/.edgerc',
section: '<section-header>'
});
eg.enableLogging(logger); // Pass the custom logger
logger.info('Using custom logger for logging.');
logger.error('An error occurred!');Proxy
To use edgegrid with proxy, you can configure it with one of these methods:
Add the
proxyargument to theEdgeGrid()method.eg.auth({ path : `/identity-management/v3/user-profile`, method: 'GET', proxy: { host: 'my.proxy.com', protocol: "https", port: 3128, auth: { username: 'my-user', password: 'my-password' } } }).send((err, response) => { if (err) { return console.log(err); } console.log('Success!'); // Do something with the response });Set the
HTTPS_PROXYenvironment variable.$ export HTTPS_PROXY=https://username:password@host:port $ node myapp.js
Reporting issues
To report an issue or make a suggestion, create a new GitHub issue.
License
Copyright 2025 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.