predix-uaa-client

Node module to get a token from UAA using client credentials

Showing:

Popularity

Downloads/wk

1.5K

GitHub Stars

4

Maintenance

Last Commit

3yrs ago

Contributors

9

Package

Dependencies

2

License

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

predix-uaa-client

Node module to get a token from UAA using client credentials or a refresh token.

Usage

Install via npm

npm install --save predix-uaa-client

This package can be used in various ways, depending on the params passed into the getToken function.

Use client credentials to get a bearer token.

In this mode, no refresh token is passed in. This call can be made for each outgoing request. The library will cache the token until expiry, so subsequent calls will resolve instantaneously.

const uaa_util = require('predix-uaa-client');
// Call with client credentials (UAAUrl, ClientID, ClientSecret),
// will fetch a client token using these credentials.
// In this case the client needs authorized_grant_types: client_credentials
uaa_util.getToken(url, clientId, clientSecret).then((token) => {
    // Use token.access_token as a Bearer token Authroization header
    // in calls to secured services.
    request.get({
        uri: 'https://secured.service.example.com',
        headers: {
            Authorization: 'Bearer ' + token.access_token
        }
    }).then((data) => {
        console.log('Got ' + data + ' from service');
    }).catch((err) => {
        console.error('Error getting data', err);
    });
}).catch((err) => {
    console.error('Error getting token', err);
});

Use a refresh token get a new access_token for a user.

When passing a refresh token, the function will NOT cache, this should only be called when a new user access token is required.

const uaa_util = require('predix-uaa-client');
// Call with client credentials (UAAUrl, ClientID, ClientSecret, RefreshToken),
// will fetch an access token for the user represented by the refresh token.
// In this case the client needs authorized_grant_types: refresh_token
uaa_util.getToken(url, clientId, clientSecret, refreshToken).then((token) => {
    // New access token is in token.access_token.
    // New refresh token is in token.refresh_token.
    console.log('New access token', token.access_token);
    console.log('New refresh token', token.refresh_token);
    console.log('New access token expires at', token.expire_time);
}).catch((err) => {
    console.error('Error getting token', err);
});

Request scopes if a token with particular scopes (ex. authZ permisions) is required.

The 5th parameter is passed as a comma separated string of scopes.

const uaa_util = require('predix-uaa-client');
// Call with client credentials (UAAUrl, ClientID, ClientSecret, null, scopes),
// will fetch an access token for the user with requested scopes.
// In this case the client needs authorized_grant_types: refresh_token
uaa_util.getToken(url, clientId, clientSecret, null, 'scope1,scope2').then((token) => {
    // New access token is in token.access_token.
    // New refresh token is in token.refresh_token.
    console.log('New access token', token.access_token);
    console.log('New refresh token', token.refresh_token);
    console.log('New access token expires at', token.expire_time);
}).catch((err) => {
    console.error('Error getting token', err);
});

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial