@axway/axway-flow-authorization NPM

@axway/axway-flow-authorization

Authorization services for API Builder.

API Reference

axway-flow-authorization.CredentialManager : axway-flow-authorization.CredentialManager

The credential manager singleton.

Kind: static property of axway-flow-authorization

axway-flow-authorization~CredentialManager

The credential manager service. Manages credentials and attempts to keep them evergreen.

Shape of an OAuth2 credential: onedrive: { access_token: , type: 'oauth2', token_url: , client_id: , client_secret: , redirect_uri: , refresh_token: }

Shape of apikey/unmanaged auth: myservice: 'mykey'

Shape of basic auth: myservice: { username: 'username', password: 'password' }

Kind: inner class of axway-flow-authorization
Access: public

~CredentialManager

new CredentialManager()

Constructs a CredentialManager. The instance is a singleton.

credentialManager.config

The authorization config for the service.

Kind: instance property of CredentialManager
Access: public

Param	Type	Description
config	object	The credential manager config.
config.credentials	object \| string	The credential to managa.

credentialManager.setLogger(logger)

Set the logger.

Kind: instance method of CredentialManager
Access: public

Param	Type	Description
logger	object	The logger.

credentialManager.getCredential(name) ⇒ *

Returns the named credential.

Kind: instance method of CredentialManager
Returns: * - The named credential or null if no credential exists.
Access: public

Param	Type	Description
name	string	The name of the credential to retrieve.

credentialManager.addCredential(credential)

Add a credential to be managed.

Kind: instance method of CredentialManager
Access: public

Param	Type	Description
credential	object	The credential to manage.
credential.name	string	The name of the credential.
credential.expiry	long	The expiration time of the current credential.
credential.type	string	The type of the credential.
credential.token	*	The current credential value (e.g. access token for oauth).
credential.refreshPolicy	string	The refresh policy of the credential.

Building

npm run build

Author

Axway support@axway.com https://axway.com

License

This code is proprietary, closed source software licensed to you by Axway. All Rights Reserved. You may not modify Axway’s code without express written permission of Axway. You are licensed to use and distribute your services developed with the use of this software and dependencies, including distributing reasonable and appropriate portions of the Axway code and dependencies. Except as set forth above, this code MUST not be copied or otherwise redistributed without express written permission of Axway. This module is licensed as part of the Axway Platform and governed under the terms of the Axway license agreement (General Conditions) located here: https://support.axway.com/en/auth/general-conditions. Your right to use this software is strictly limited to the term (if any) of the license or subscription originally granted to you.