ibm-cloud-sdk-core 2.15.1 → 2.16.0

package/.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "package-lock.json|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2021-10-15T14:47:01Z",
+  "generated_at": "2021-10-20T21:45:37Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -70,31 +70,23 @@
         "hashed_secret": "91dfd9ddb4198affc5c194cd8ce6d338fde470e2",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 57,
+        "line_number": 73,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
-        "hashed_secret": "47fcf185ee7e15fe05cae31fbe9e4ebe4a06a40d",
+        "hashed_secret": "98635b2eaa2379f28cd6d72a38299f286b81b459",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 122,
+        "line_number": 334,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
-        "hashed_secret": "24c3d19b8d127fe8f7274108156a718ec56fc6e6",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 136,
-        "type": "Secret Keyword",
-        "verified_result": null
-      },
-      {
-        "hashed_secret": "32e8612d8ca77c7ea8374aa7918db8e5df9252ed",
+        "hashed_secret": "47fcf185ee7e15fe05cae31fbe9e4ebe4a06a40d",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 171,
+        "line_number": 372,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -232,7 +224,7 @@
         "hashed_secret": "f84f793e0af9ade37c8b927bc5091e98f35bf821",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 81,
+        "line_number": 83,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -240,7 +232,7 @@
         "hashed_secret": "45c43fe97e3a06ab078b0eeff6fbe622cc417a25",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 118,
+        "line_number": 120,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -248,7 +240,7 @@
         "hashed_secret": "99833a8b234b57b886a9aef1dba187fdd7ceece8",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 120,
+        "line_number": 122,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -258,7 +250,7 @@
         "hashed_secret": "8f4bfc22c4fd7cb884f94ec175ff4a3284a174a1",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 60,
+        "line_number": 58,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -266,7 +258,7 @@
         "hashed_secret": "0358c67856fb6a21c4767daf02fcb8fe4dc0a318",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 63,
+        "line_number": 61,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -274,7 +266,7 @@
         "hashed_secret": "dbb19b8ae3b78f908e1467721fe4c9f0b0529d9b",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 64,
+        "line_number": 62,
         "type": "Secret Keyword",
         "verified_result": null
       }
@@ -532,7 +524,7 @@
       }
     ]
   },
-  "version": "0.13.1+ibm.46.dss",
+  "version": "0.13.1+ibm.40.dss",
   "word_list": {
     "file": null,
     "hash": null

package/Authentication.md

@@ -1,19 +1,25 @@
 # Authentication
 The node-sdk-core project supports the following types of authentication:
 - Basic Authentication
-- Bearer Token
-- Identity and Access Management (IAM)
-- Cloud Pak for Data
-- Container
+- Bearer Token Authentication
+- Identity and Access Management (IAM) Authentication
+- Container Authentication
+- Cloud Pak for Data Authentication
 - No Authentication
 
-The SDK user configures the appropriate type of authentication for use with service instances.
-
-The authentication types that are appropriate for a particular service may vary from service to service, so it is important for the SDK user to consult with the appropriate service documentation to understand which authenticators are supported for that service.
+The SDK user configures the appropriate type of authentication for use with service instances.  
+The authentication types that are appropriate for a particular service may vary from service to service,
+so it is important for the SDK user to consult with the appropriate service documentation to understand
+which authentication types are supported for that service.
 
 The node-sdk-core allows an authenticator to be specified in one of two ways:
-1. programmatically - the SDK user invokes the appropriate function(s) to create an instance of the desired authenticator and then passes the authenticator instance when constructing an instance of the service.
-2. configuration - the SDK user provides external configuration information (in the form of environment variables or a credentials file) to indicate the type of authenticator along with the configuration of the necessary properties for that authenticator.  The SDK user then invokes the configuration-based authenticator factory to construct an instance of the authenticator that is described in the external configuration information.
+1. programmatically - the SDK user invokes the appropriate function(s) to create an instance of the 
+desired authenticator and then passes the authenticator instance when constructing an instance of the service client.
+2. configuration - the SDK user provides external configuration information (in the form of environment variables
+or a credentials file) to indicate the type of authenticator, along with the configuration of the necessary properties
+for that authenticator.
+The SDK user then invokes the configuration-based service client constructor method
+to construct an instance of the authenticator and service client that reflect the external configuration information.
 
 The sections below will provide detailed information for each authenticator
 which will include the following:
@@ -25,6 +31,7 @@ configuration information.  The configuration examples below will use
 environment variables, although the same properties could be specified in a
 credentials file instead.
 
+
 ## Basic Authentication
 The `BasicAuthenticator` is used to add Basic Authentication information to
 each outbound request in the `Authorization` header in the form:
@@ -34,30 +41,51 @@ each outbound request in the `Authorization` header in the form:
 ```
 
 ### Properties
+
 - username: (required) the basic auth username
+
 - password: (required) the basic auth password
 
 ### Programming example
 ```js
-import { BasicAuthenticator } from 'ibm-cloud-sdk-core';
+const { BasicAuthenticator } = require('ibm-cloud-sdk-core');
+const ExampleServiceV1 = require('<sdk-package-name>/example-service/v1');
 
 const authenticator = new BasicAuthenticator({
-  username: '{username}',
-  password: '{password}',
+  username: 'myuser',
+  password: 'mypassword',
 });
+
+const options = {
+  authenticator,
+};
+
+const service = new ExampleServiceV1(options);
+
+// 'service' can now be used to invoke operations.
 ```
 
-### External configuration example
+### Configuration example
+External configuration:
+```
+export EXAMPLE_SERVICE_AUTH_TYPE=basic
+export EXAMPLE_SERVICE_USERNAME=myuser
+export EXAMPLE_SERVICE_PASSWORD=mypassword
+```
+Application code:
 ```js
-import { getAuthenticatorFromEnvironment } from 'ibm-cloud-sdk-core';
+const ExampleServiceV1 = require('<sdk-package-name>/example-service/v1');
+
+const options = {
+  serviceName: 'example_service',
+};
 
-// env vars
-// MY_SERVICE_AUTH_TYPE=basic
-// MY_SERVICE_USERNAME=myusername
-// MY_SERVICE_PASSWORD=mypassword
-const basicAuthenticator = getAuthenticatorFromEnvironment('my-service');
+const service = ExampleServiceV1.newInstance(options);
+
+// 'service' can now be used to invoke operations.
 ```
 
+
 ## Bearer Token Authentication
 The `BearerTokenAuthenticator` will add a user-supplied bearer token to
 each outbound request in the `Authorization` header in the form:
@@ -67,112 +95,130 @@ each outbound request in the `Authorization` header in the form:
 ```
 
 ### Properties
+
 - bearerToken: (required) the bearer token value
 
 ### Programming example
 ```js
-import { BearerTokenAuthenticator } from 'ibm-cloud-sdk-core';
+const { BearerTokenAuthenticator } = require('ibm-cloud-sdk-core');
+const ExampleServiceV1 = require('<sdk-package-name>/example-service/v1');
 
+const bearerToken = // ... obtain bearer token value ...
 const authenticator = new BearerTokenAuthenticator({
-  bearerToken: '{bearerToken}',
+  bearerToken: bearerToken,
 });
+
+const options = {
+  authenticator,
+};
+
+const service = new ExampleServiceV1(options);
+
+// 'service' can now be used to invoke operations.
+...
+// Later, if your bearer token value expires, you can set a new one like this:
+newToken = // ... obtain new bearer token value
+authenticator.bearerToken = newToken;
 ```
 
-### External configuration example
+### Configuration example
+External configuration:
+```
+export EXAMPLE_SERVICE_AUTH_TYPE=bearertoken
+export EXAMPLE_SERVICE_BEARER_TOKEN=<the bearer token value>
+```
+Application code:
 ```js
-import { getAuthenticatorFromEnvironment } from 'ibm-cloud-sdk-core';
+const ExampleServiceV1 = require('<sdk-package-name>/example-service/v1');
+
+const options = {
+  serviceName: 'example_service',
+};
+
+const service = ExampleServiceV1.newInstance(options);
 
-// env vars
-// MY_SERVICE_AUTH_TYPE=bearerToken
-// MY_SERVICE_BEARER_TOKEN=somebearertoken
-const bearerTokenAuthenticator = getAuthenticatorFromEnvironment('my-service');
+// 'service' can now be used to invoke operations.
 ```
 
-Note that the use of external configuration is not as useful with the `BearerTokenAuthenticator` as it is for other authenticator types because bearer tokens typically need to be obtained and refreshed programmatically since they normally have a relatively short lifespan before they expire.  This authenticator type is intended for situations in which the application will be managing the bearer token itself in terms of initial acquisition and refreshing as needed.
+Note that the use of external configuration is not as useful with the `BearerTokenAuthenticator` as it
+is for other authenticator types because bearer tokens typically need to be obtained and refreshed
+programmatically since they normally have a relatively short lifespan before they expire.  This
+authenticator type is intended for situations in which the application will be managing the bearer 
+token itself in terms of initial acquisition and refreshing as needed.
 
-## Identity and Access Management Authentication (IAM)
-The `IamAuthenticator` will accept a user-supplied api key and will perform the necessary interactions with the IAM token service to obtain a suitable bearer token for the specified api key.  The authenticator will also obtain  a new bearer token when the current token expires.  The bearer token is  then added to each outbound request in the `Authorization` header in the form:
 
+## Identity and Access Management Authentication (IAM)
+The `IamAuthenticator` will accept a user-supplied api key and will perform
+the necessary interactions with the IAM token service to obtain a suitable
+bearer token for the specified api key.  The authenticator will also obtain 
+a new bearer token when the current token expires.  The bearer token is 
+then added to each outbound request in the `Authorization` header in the
+form:
 ```
    Authorization: Bearer <bearer-token>
 ```
 
 ### Properties
+
 - apikey: (required) the IAM api key
-- url: (optional) The URL representing the IAM token service endpoint.  If not specified, a suitable default value is used.
-- clientId/clientSecret: (optional) The `clientId` and `clientSecret` fields are used to form a "basic auth" Authorization header for interactions with the IAM token server. If neither field is specified, then no Authorization header will be sent with token server requests.  These fields are optional, but must be specified together.
-- disableSslVerification: (optional) A flag that indicates whether verificaton of the server's SSL certificate should be disabled or not. The default value is `false`.
-- headers: (optional) A set of key/value pairs that will be sent as HTTP headers in requests made to the IAM token service.
+
+- url: (optional) The base endpoint URL of the IAM token service.
+The default value of this property is the "prod" IAM token service endpoint
+(`https://iam.cloud.ibm.com`).
+
+- clientId/clientSecret: (optional) The `clientId` and `clientSecret` fields are used to form a
+"basic auth" Authorization header for interactions with the IAM token server. If neither field
+is specified, then no Authorization header will be sent with token server requests.  These fields
+are optional, but must be specified together.
+
+- scope: (optional) the scope to be associated with the IAM access token.
+If not specified, then no scope wil be associated with the access token.
+
+- disableSslVerification: (optional) A flag that indicates whether verificaton of the server's SSL
+certificate should be disabled or not. The default value is `false`.
+
+- headers: (optional) A set of key/value pairs that will be sent as HTTP headers in requests
+made to the IAM token service.
 
 ### Programming example
 ```js
-import { IamAuthenticator } from 'ibm-cloud-sdk-core';
+const { IamAuthenticator } = require('ibm-cloud-sdk-core');
+const ExampleServiceV1 = require('<sdk-package-name>/example-service/v1');
 
 const authenticator = new IamAuthenticator({
-  apikey: '{apikey}',
+  apikey: 'myapikey',
 });
-```
 
-### External configuration example
-```js
-import { getAuthenticatorFromEnvironment } from 'ibm-cloud-sdk-core';
+const options = {
+  authenticator,
+};
 
-// env vars
-// MY_SERVICE_AUTH_TYPE=iam
-// MY_SERVICE_APIKEY=myapikey
-const iamAuthenticator = getAuthenticatorFromEnvironment('my-service');
-```
+const service = new ExampleServiceV1(options);
 
-##  Cloud Pak for Data
-The `CloudPakForDataAuthenticator` will accept user-supplied username and password values, and will perform the necessary interactions with the Cloud Pak for Data token service to obtain a suitable bearer token.  The authenticator will also obtain a new bearer token when the current token expires. The bearer token is then added to each outbound request in the `Authorization` header in the form:
+// 'service' can now be used to invoke operations.
+```
 
+### Configuration example
+External configuration:
 ```
-   Authorization: Bearer <bearer-token>
+export EXAMPLE_SERVICE_AUTH_TYPE=iam
+export EXAMPLE_SERVICE_APIKEY=myapikey
 ```
-
-### Properties
-- username: (required) the username used to obtain a bearer token.
-- password: (password or apikey required) the password used to obtain a bearer token.
-- apikey: (password or apikey required) the API key used to obtain a bearer token.
-- url: (required) The URL representing the Cloud Pak for Data token service endpoint.
-- disableSslVerification: (optional) A flag that indicates whether verificaton of the server's SSL certificate should be disabled or not. The default value is `false`.
-- headers: (optional) A set of key/value pairs that will be sent as HTTP headers in requests made to the IAM token service.
-
-### Programming examples
+Application code:
 ```js
-import { CloudPakForDataAuthenticator } from 'ibm-cloud-sdk-core';
+const ExampleServiceV1 = require('<sdk-package-name>/example-service/v1');
 
-const authenticator = new CloudPakForDataAuthenticator({
-  username: '{username}',
-  password: '{password}',
-  url: '{url}',
-});
-```
+const options = {
+  serviceName: 'example_service',
+};
 
-```js
-import { CloudPakForDataAuthenticator } from 'ibm-cloud-sdk-core';
+const service = ExampleServiceV1.newInstance(options);
 
-const authenticator = new CloudPakForDataAuthenticator({
-  username: '{username}',
-  apikey: '{apikey}',
-  url: '{url}',
-});
+// 'service' can now be used to invoke operations.
 ```
 
-### External configuration example
-```js
-import { getAuthenticatorFromEnvironment } from 'ibm-cloud-sdk-core';
-
-// env vars
-// MY_SERVICE_AUTH_TYPE=cp4d
-// MY_SERVICE_AUTH_URL=<url>
-// MY_SERVICE_USERNAME=<username>
-// MY_SERVICE_PASSWORD=<password>
-// MY_SERVICE_APIKEY=<apikey>
-const cp4dAuthenticator = getAuthenticatorFromEnvironment('my-service');
-```
 
-## Container
+## Container Authentication
 The `ContainerAuthenticator` is intended to be used by application code
 running inside a compute resource managed by the IBM Kubernetes Service (IKS)
 in which a secure compute resource token (CR token) has been stored in a file
@@ -195,51 +241,189 @@ The IAM access token is added to each outbound request in the `Authorization` he
 ```
 
 ### Properties
-- crTokenFilename: (optional) The name of the file containing the injected CR token value. If not specified, then `/var/run/secrets/tokens/vault-token` is used as the default value. The application must have `read` permissions on the file containing the CR token value.
-- iamProfileName: (optional) The name of the linked trusted IAM profile to be used when obtaining the IAM access token (a CR token might map to multiple IAM profiles). One of `iamProfileName` or `iamProfileId` must be specified.
-- iamProfileId: (optional) The ID of the linked trusted IAM profile to be used when obtaining the IAM access token (a CR token might map to multiple IAM profiles). One of `iamProfileName` or `iamProfileId` must be specified.
-- url: (optional) The URL representing the IAM token service endpoint.  If not specified, a suitable default value is used.
-- clientId/clientSecret: (optional) The `clientId` and `clientSecret` fields are used to form a "basic auth" Authorization header for interactions with the IAM token server. If neither field is specified, then no Authorization header will be sent with token server requests.  These fields are optional, but must be specified together.
-- disableSslVerification: (optional) A flag that indicates whether verificaton of the server's SSL certificate should be disabled or not. The default value is `false`.
-- headers: (optional) A set of key/value pairs that will be sent as HTTP headers in requests made to the IAM token service.
+
+- crTokenFilename: (optional) the name of the file containing the injected CR token value.
+If not specified, then `/var/run/secrets/tokens/vault-token` is used as the default value.
+The application must have `read` permissions on the file containing the CR token value.
+
+- iamProfileName: (optional) the name of the linked trusted IAM profile to be used when obtaining the
+IAM access token (a CR token might map to multiple IAM profiles).
+One of `iamProfileName` or `iamProfileId` must be specified.
+
+- iamProfileId: (optional) the id of the linked trusted IAM profile to be used when obtaining the
+IAM access token (a CR token might map to multiple IAM profiles).
+One of `iamProfileName` or `iamProfileId` must be specified.
+
+- url: (optional) The base endpoint URL of the IAM token service.
+The default value of this property is the "prod" IAM token service endpoint
+(`https://iam.cloud.ibm.com`).
+
+- clientId/clientSecret: (optional) The `clientId` and `clientSecret` fields are used to form a 
+"basic auth" Authorization header for interactions with the IAM token service. If neither field 
+is specified, then no Authorization header will be sent with token server requests.  These fields 
+are optional, but must be specified together.
+
+- scope: (optional) the scope to be associated with the IAM access token.
+If not specified, then no scope will be associated with the access token.
+
+- disableSslVerification: (optional) A flag that indicates whether verificaton of the server's SSL 
+certificate should be disabled or not. The default value is `false`.
+
+- headers: (optional) A set of key/value pairs that will be sent as HTTP headers in requests
+made to the IAM token service.
+
+- crTokenFilename: (optional) The name of the file containing the injected CR token value.
+If not specified, then `/var/run/secrets/tokens/vault-token` is used as the default value.
+The application must have `read` permissions on the file containing the CR token value.
 
 ### Programming example
 ```js
-import { ContainerAuthenticator } from 'ibm-cloud-sdk-core';
+const { ContainerAuthenticator } = require('ibm-cloud-sdk-core');
+const ExampleServiceV1 = require('<sdk-package-name>/example-service/v1');
 
 const authenticator = new ContainerAuthenticator({
-  iamProfileName: '{profile-name}',
+  iamProfileName: 'iam-user123',
 });
+
+const options = {
+  authenticator,
+};
+
+const service = new ExampleServiceV1(options);
+
+// 'service' can now be used to invoke operations.
 ```
 
-### External configuration example
+### Configuration example
+External configuration:
+```
+export EXAMPLE_SERVICE_AUTH_TYPE=container
+export EXAMPLE_SERVICE_IAM_PROFILE_NAME=iam-user123
+```
+Application code:
 ```js
-import { getAuthenticatorFromEnvironment } from 'ibm-cloud-sdk-core';
+const ExampleServiceV1 = require('<sdk-package-name>/example-service/v1');
+
+const options = {
+  serviceName: 'example_service',
+};
+
+const service = ExampleServiceV1.newInstance(options);
+
+// 'service' can now be used to invoke operations.
+```
+
 
-// env vars
-// MY_SERVICE_AUTH_TYPE=container
-// MY_SERVICE_IAM_PROFILE_ID=my_profile_name
-const containerAuthenticator = getAuthenticatorFromEnvironment('my-service');
+##  Cloud Pak for Data Authentication
+The `CloudPakForDataAuthenticator` will accept a user-supplied username value, along with either a
+password or apikey, and will 
+perform the necessary interactions with the Cloud Pak for Data token service to obtain a suitable
+bearer token.  The authenticator will also obtain a new bearer token when the current token expires.
+The bearer token is then added to each outbound request in the `Authorization` header in the
+form:
+```
+   Authorization: Bearer <bearer-token>
 ```
+### Properties
+
+- username: (required) the username used to obtain a bearer token.
+
+- password: (required if apikey is not specified) the user's password used to obtain a bearer token.
+Exactly one of password or apikey should be specified.
+
+- apikey: (required if password is not specified) the user's apikey used to obtain a bearer token.
+Exactly one of password or apikey should be specified.
+
+- url: (required) The URL representing the Cloud Pak for Data token service endpoint's base URL string.
+This value should not include the `/v1/authorize` path portion.
+
+- disableSslVerification: (optional) A flag that indicates whether verificaton of the server's SSL 
+certificate should be disabled or not. The default value is `false`.
+
+- headers: (optional) A set of key/value pairs that will be sent as HTTP headers in requests
+made to the Cloud Pak for Data token service.
+
+### Programming examples
+```js
+const { CloudPakForDataAuthenticator } = require('ibm-cloud-sdk-core');
+const ExampleServiceV1 = require('<sdk-package-name>/example-service/v1');
+
+const authenticator = new CloudPakForDataAuthenticator({
+  username: 'myuser',
+  apikey: 'myapikey',
+  url: 'https://mycp4dhost.com',
+});
+
+const options = {
+  authenticator,
+};
+
+const service = new ExampleServiceV1(options);
+
+// 'service' can now be used to invoke operations.
+```
+
+### Configuration example
+External configuration:
+```
+# Configure "example_service" with username/apikey.
+export EXAMPLE_SERVICE_AUTH_TYPE=cp4d
+export EXAMPLE_SERVICE_USERNAME=myuser
+export EXAMPLE_SERVICE_APIKEY=myapikey
+export EXAMPLE_SERVICE_URL=https://mycp4dhost.com
+```
+Application code:
+```js
+const ExampleServiceV1 = require('<sdk-package-name>/example-service/v1');
+
+const options = {
+  serviceName: 'example_service',
+};
+
+const service = ExampleServiceV1.newInstance(options);
+
+// 'service' can now be used to invoke operations.
+```
+
 
 ## No Auth Authentication
-The `NoAuthAuthenticator` is a placeholder authenticator which performs no actual authentication function.   It can be used in situations where authentication needs to be bypassed, perhaps while developing or debugging an application or service.
+The `NoAuthAuthenticator` is a placeholder authenticator which performs no actual authentication function.
+It can be used in situations where authentication needs to be bypassed, perhaps while developing
+or debugging an application or service.
 
 ### Properties
 None
 
 ### Programming example
 ```js
-import { NoAuthAuthenticator } from 'ibm-cloud-sdk-core';
+const { NoAuthAuthenticator } = require('ibm-cloud-sdk-core');
+const ExampleServiceV1 = require('<sdk-package-name>/example-service/v1');
 
 const authenticator = new NoAuthAuthenticator();
+
+const options = {
+  authenticator,
+};
+
+const service = new ExampleServiceV1(options);
+
+// 'service' can now be used to invoke operations.
 ```
 
-### External configuration example
+### Configuration example
+External configuration:
+```
+export EXAMPLE_SERVICE_AUTH_TYPE=noauth
+```
+Application code:
 ```js
-import { getAuthenticatorFromEnvironment } from 'ibm-cloud-sdk-core';
+const ExampleServiceV1 = require('<sdk-package-name>/example-service/v1');
+
+const options = {
+  serviceName: 'example_service',
+};
+
+const service = ExampleServiceV1.newInstance(options);
 
-// env vars
-// MY_SERVICE_AUTH_TYPE=noauth
-const noAuthAuthenticator = getAuthenticatorFromEnvironment('my-service');
+// 'service' can now be used to invoke operations.
 ```

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [2.16.0](https://github.com/IBM/node-sdk-core/compare/v2.15.1...v2.16.0) (2021-10-20)
+
+
+### Features
+
+* add support for retrieving refresh tokens from iam-based authenticators ([#173](https://github.com/IBM/node-sdk-core/issues/173)) ([e7f11fc](https://github.com/IBM/node-sdk-core/commit/e7f11fce7bbbfff1273c289b9e9b8fba27c705dc))
+
 ## [2.15.1](https://github.com/IBM/node-sdk-core/compare/v2.15.0...v2.15.1) (2021-10-15)
 
 

package/auth/authenticators/iam-authenticator.d.ts

@@ -55,13 +55,6 @@ export declare class IamAuthenticator extends IamRequestBasedAuthenticator {
      * @throws {Error} When the configuration options are not valid.
      */
     constructor(options: Options);
-    /**
-     * Return the most recently stored refresh token.
-     *
-     * @public
-     * @returns {string}
-     */
-    getRefreshToken(): string;
     /**
      * Returns the authenticator's type ('iam').
      *

package/auth/authenticators/iam-authenticator.js

@@ -74,15 +74,6 @@ var IamAuthenticator = /** @class */ (function (_super) {
         _this.tokenManager = new token_managers_1.IamTokenManager(options);
         return _this;
     }
-    /**
-     * Return the most recently stored refresh token.
-     *
-     * @public
-     * @returns {string}
-     */
-    IamAuthenticator.prototype.getRefreshToken = function () {
-        return this.tokenManager.getRefreshToken();
-    };
     /**
      * Returns the authenticator's type ('iam').
      *

package/auth/authenticators/iam-request-based-authenticator.d.ts

@@ -74,4 +74,11 @@ export declare class IamRequestBasedAuthenticator extends TokenRequestBasedAuthe
      * @param {string} scope A space seperated string that makes up the scope parameter
      */
     setScope(scope: string): void;
+    /**
+     * Return the most recently stored refresh token.
+     *
+     * @public
+     * @returns {string}
+     */
+    getRefreshToken(): string;
 }

package/auth/authenticators/iam-request-based-authenticator.js

@@ -88,6 +88,15 @@ var IamRequestBasedAuthenticator = /** @class */ (function (_super) {
         // update properties in token manager
         this.tokenManager.setScope(scope);
     };
+    /**
+     * Return the most recently stored refresh token.
+     *
+     * @public
+     * @returns {string}
+     */
+    IamRequestBasedAuthenticator.prototype.getRefreshToken = function () {
+        return this.tokenManager.getRefreshToken();
+    };
     return IamRequestBasedAuthenticator;
 }(token_request_based_authenticator_1.TokenRequestBasedAuthenticator));
 exports.IamRequestBasedAuthenticator = IamRequestBasedAuthenticator;

package/auth/token-managers/iam-request-based-token-manager.d.ts

@@ -31,6 +31,7 @@ export declare class IamRequestBasedTokenManager extends JwtTokenManager {
     private clientId;
     private clientSecret;
     private scope;
+    protected refreshToken: string;
     protected formData: any;
     /**
      *
@@ -71,6 +72,22 @@ export declare class IamRequestBasedTokenManager extends JwtTokenManager {
      * @returns {void}
      */
     setClientIdAndSecret(clientId: string, clientSecret: string): void;
+    /**
+     * Return the most recently stored refresh token.
+     *
+     * @public
+     * @returns {string}
+     */
+    getRefreshToken(): string;
+    /**
+     * Extend this method from the parent class to extract the refresh token from
+     * the request and save it.
+     *
+     * @param tokenResponse - Response object from JWT service request
+     * @protected
+     * @returns {void}
+     */
+    protected saveTokenInfo(tokenResponse: any): void;
     /**
      * Request an IAM token using an API key.
      *

package/auth/token-managers/iam-request-based-token-manager.js

@@ -115,6 +115,30 @@ var IamRequestBasedTokenManager = /** @class */ (function (_super) {
             logger_1.default.warn(CLIENT_ID_SECRET_WARNING);
         }
     };
+    /**
+     * Return the most recently stored refresh token.
+     *
+     * @public
+     * @returns {string}
+     */
+    IamRequestBasedTokenManager.prototype.getRefreshToken = function () {
+        return this.refreshToken;
+    };
+    /**
+     * Extend this method from the parent class to extract the refresh token from
+     * the request and save it.
+     *
+     * @param tokenResponse - Response object from JWT service request
+     * @protected
+     * @returns {void}
+     */
+    IamRequestBasedTokenManager.prototype.saveTokenInfo = function (tokenResponse) {
+        _super.prototype.saveTokenInfo.call(this, tokenResponse);
+        var responseBody = tokenResponse.result || {};
+        if (responseBody.refresh_token) {
+            this.refreshToken = responseBody.refresh_token;
+        }
+    };
     /**
      * Request an IAM token using an API key.
      *

package/auth/token-managers/iam-token-manager.d.ts

@@ -25,7 +25,6 @@ interface Options extends IamRequestOptions {
  */
 export declare class IamTokenManager extends IamRequestBasedTokenManager {
     protected requiredOptions: string[];
-    protected refreshToken: string;
     private apikey;
     /**
      *
@@ -46,21 +45,5 @@ export declare class IamTokenManager extends IamRequestBasedTokenManager {
      * @constructor
      */
     constructor(options: Options);
-    /**
-     * Return the most recently stored refresh token.
-     *
-     * @public
-     * @returns {string}
-     */
-    getRefreshToken(): string;
-    /**
-     * Extend this method from the parent class to extract the refresh token from
-     * the request and save it.
-     *
-     * @param tokenResponse - Response object from JWT service request
-     * @protected
-     * @returns {void}
-     */
-    protected saveTokenInfo(tokenResponse: any): void;
 }
 export {};

package/auth/token-managers/iam-token-manager.js

@@ -66,30 +66,6 @@ var IamTokenManager = /** @class */ (function (_super) {
         _this.formData.response_type = 'cloud_iam';
         return _this;
     }
-    /**
-     * Return the most recently stored refresh token.
-     *
-     * @public
-     * @returns {string}
-     */
-    IamTokenManager.prototype.getRefreshToken = function () {
-        return this.refreshToken;
-    };
-    /**
-     * Extend this method from the parent class to extract the refresh token from
-     * the request and save it.
-     *
-     * @param tokenResponse - Response object from JWT service request
-     * @protected
-     * @returns {void}
-     */
-    IamTokenManager.prototype.saveTokenInfo = function (tokenResponse) {
-        _super.prototype.saveTokenInfo.call(this, tokenResponse);
-        var responseBody = tokenResponse.result || {};
-        if (responseBody.refresh_token) {
-            this.refreshToken = responseBody.refresh_token;
-        }
-    };
     return IamTokenManager;
 }(iam_request_based_token_manager_1.IamRequestBasedTokenManager));
 exports.IamTokenManager = IamTokenManager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "2.15.1",
+  "version": "2.16.0",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index",
   "repository": {