ibm-cloud-sdk-core 4.0.0 → 4.0.2

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

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -52,20 +52,21 @@ var IamRequestBasedTokenManager = /** @class */ (function (_super) {
     __extends(IamRequestBasedTokenManager, _super);
     /**
      *
-     * Create a new [[IamRequestBasedTokenManager]] instance.
+     * Create a new IamRequestBasedTokenManager instance.
      *
-     * @param {object} options Configuration options.
-     * @param {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [url='https://iam.cloud.ibm.com'] The IAM endpoint for token requests.
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not.
-     * @param {object<string, string>} [options.headers] Headers to be sent with every
-     *   outbound HTTP requests to token services.
-     * @constructor
+     * @param options - Configuration options.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service (default value: "https://iam.cloud.ibm.com")
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     * - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
+     *
+     * @throws Error: the configuration options are not valid.
      */
     function IamRequestBasedTokenManager(options) {
         var _this = this;
@@ -92,26 +93,23 @@ var IamRequestBasedTokenManager = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * Set the IAM `scope` value.
-     * This value is the form parameter to use when fetching the bearer token
-     * from the IAM token server.
+     * Sets the IAM "scope" value.
+     * This value is sent as the "scope" form parameter within the request sent to the IAM token service.
      *
-     * @param {string} scope - A space seperated string that makes up the scope parameter.
-     * @returns {void}
+     * @param scope - a space-separated string that contains one or more scope names
      */
     IamRequestBasedTokenManager.prototype.setScope = function (scope) {
         this.scope = scope;
     };
     /**
-     * Set the IAM `clientId` and `clientSecret` values.
+     * Sets the IAM "clientId" and "clientSecret" values.
      * These values are used to compute the Authorization header used
      * when retrieving the IAM access token.
      * If these values are not set, no Authorization header will be
      * set on the request (it is not required).
      *
-     * @param {string} clientId - The client id.
-     * @param {string} clientSecret - The client secret.
-     * @returns {void}
+     * @param clientId - the client id.
+     * @param clientSecret - the client secret.
      */
     IamRequestBasedTokenManager.prototype.setClientIdAndSecret = function (clientId, clientSecret) {
         this.clientId = clientId;
@@ -122,10 +120,9 @@ var IamRequestBasedTokenManager = /** @class */ (function (_super) {
         }
     };
     /**
-     * Return the most recently stored refresh token.
+     * Returns the most recently stored refresh token.
      *
-     * @public
-     * @returns {string}
+     * @returns the refresh token
      */
     IamRequestBasedTokenManager.prototype.getRefreshToken = function () {
         return this.refreshToken;
@@ -134,9 +131,7 @@ var IamRequestBasedTokenManager = /** @class */ (function (_super) {
      * 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}
+     * @param tokenResponse - the response object from JWT service request
      */
     IamRequestBasedTokenManager.prototype.saveTokenInfo = function (tokenResponse) {
         _super.prototype.saveTokenInfo.call(this, tokenResponse);
@@ -146,9 +141,9 @@ var IamRequestBasedTokenManager = /** @class */ (function (_super) {
         }
     };
     /**
-     * Request an IAM token using an API key.
+     * Request an IAM access token using an API key.
      *
-     * @returns {Promise}
+     * @returns Promise
      */
     IamRequestBasedTokenManager.prototype.requestToken = function () {
         // these cannot be overwritten

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

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,28 +21,29 @@ interface Options extends IamRequestOptions {
 /**
  * The IAMTokenManager takes an api key and performs the necessary interactions with
  * the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager
- * will retrieve bearer tokens via basic auth using a supplied `clientId` and `clientSecret` pair.
+ * will retrieve bearer tokens via basic auth using a supplied "clientId" and "clientSecret" pair.
  */
 export declare class IamTokenManager extends IamRequestBasedTokenManager {
     protected requiredOptions: string[];
     private apikey;
     /**
      *
-     * Create a new [[IamTokenManager]] instance.
+     * Create a new IamTokenManager instance.
      *
-     * @param {object} options Configuration options.
-     * @param {string} options.apikey The IAM api key.
-     * @param {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [url='https://iam.cloud.ibm.com'] The IAM endpoint for token requests.
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not.
-     * @param {object<string, string>} [options.headers] Headers to be sent with every
-     *   outbound HTTP requests to token services.
-     * @constructor
+     * @param options - Configuration options.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the IAM token service (default value: "https://iam.cloud.ibm.com")
+     * - apikey: (required) the IAM api key
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     * - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
+     *
+     * @throws Error: the configuration options are not valid.
      */
     constructor(options: Options);
 }

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

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,27 +36,28 @@ var iam_request_based_token_manager_1 = require("./iam-request-based-token-manag
 /**
  * The IAMTokenManager takes an api key and performs the necessary interactions with
  * the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager
- * will retrieve bearer tokens via basic auth using a supplied `clientId` and `clientSecret` pair.
+ * will retrieve bearer tokens via basic auth using a supplied "clientId" and "clientSecret" pair.
  */
 var IamTokenManager = /** @class */ (function (_super) {
     __extends(IamTokenManager, _super);
     /**
      *
-     * Create a new [[IamTokenManager]] instance.
+     * Create a new IamTokenManager instance.
      *
-     * @param {object} options Configuration options.
-     * @param {string} options.apikey The IAM api key.
-     * @param {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [url='https://iam.cloud.ibm.com'] The IAM endpoint for token requests.
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not.
-     * @param {object<string, string>} [options.headers] Headers to be sent with every
-     *   outbound HTTP requests to token services.
-     * @constructor
+     * @param options - Configuration options.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the IAM token service (default value: "https://iam.cloud.ibm.com")
+     * - apikey: (required) the IAM api key
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     * - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
+     *
+     * @throws Error: the configuration options are not valid.
      */
     function IamTokenManager(options) {
         var _this = _super.call(this, options) || this;

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

@@ -11,29 +11,26 @@ export declare class JwtTokenManager extends TokenManager {
     protected tokenName: string;
     protected tokenInfo: any;
     /**
-     * Create a new [[JwtTokenManager]] instance.
-     * @constructor
-     * @param {object} options Configuration options.
-     * @param {string} options.url for HTTP token requests.
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not.
-     * @param {object<string, string>} [options.headers] Headers to be sent with every
-     *   outbound HTTP requests to token services.
+     * Create a new JwtTokenManager instance.
+     *
+     * @param options - Configuration options.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
      */
     constructor(options: JwtTokenManagerOptions);
     /**
      * Request a JWT using an API key.
      *
-     * @returns {Promise}
+     * @returns Promise
      */
     protected requestToken(): Promise<any>;
     /**
      * Save the JWT service response and the calculated expiration time to the object's state.
      *
-     * @param tokenResponse - Response object from JWT service request
-     * @protected
-     * @returns {void}
+     * @param tokenResponse - the response object from JWT service request
      */
     protected saveTokenInfo(tokenResponse: any): void;
 }

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

@@ -32,7 +32,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JwtTokenManager = void 0;
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -58,15 +58,14 @@ var token_manager_1 = require("./token-manager");
 var JwtTokenManager = /** @class */ (function (_super) {
     __extends(JwtTokenManager, _super);
     /**
-     * Create a new [[JwtTokenManager]] instance.
-     * @constructor
-     * @param {object} options Configuration options.
-     * @param {string} options.url for HTTP token requests.
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not.
-     * @param {object<string, string>} [options.headers] Headers to be sent with every
-     *   outbound HTTP requests to token services.
+     * Create a new JwtTokenManager instance.
+     *
+     * @param options - Configuration options.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
      */
     function JwtTokenManager(options) {
         var _this = this;
@@ -80,7 +79,7 @@ var JwtTokenManager = /** @class */ (function (_super) {
     /**
      * Request a JWT using an API key.
      *
-     * @returns {Promise}
+     * @returns Promise
      */
     JwtTokenManager.prototype.requestToken = function () {
         var errMsg = '`requestToken` MUST be overridden by a subclass of JwtTokenManagerV1.';
@@ -91,9 +90,7 @@ var JwtTokenManager = /** @class */ (function (_super) {
     /**
      * Save the JWT service response and the calculated expiration time to the object's state.
      *
-     * @param tokenResponse - Response object from JWT service request
-     * @protected
-     * @returns {void}
+     * @param tokenResponse - the response object from JWT service request
      */
     JwtTokenManager.prototype.saveTokenInfo = function (tokenResponse) {
         var responseBody = tokenResponse.result || {};
@@ -103,14 +100,14 @@ var JwtTokenManager = /** @class */ (function (_super) {
             logger_1.default.error(err);
             throw new Error(err);
         }
-        // the time of expiration is found by decoding the JWT access token
-        // exp is the time of expire and iat is the time of token retrieval
         var decodedResponse = (0, jsonwebtoken_1.decode)(this.accessToken);
         if (!decodedResponse) {
             var err = 'Access token recieved is not a valid JWT';
             logger_1.default.error(err);
             throw new Error(err);
         }
+        // the time of expiration is found by decoding the JWT access token
+        // 'exp' is the time of expire and 'iat' is the time of token retrieval
         var exp = decodedResponse.exp, iat = decodedResponse.iat;
         // There are no required claims in JWT
         if (!exp || !iat) {

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

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 /**
- * (C) Copyright IBM Corp. 2020, 2021.
+ * (C) Copyright IBM Corp. 2020, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,8 +33,8 @@ export type TokenManagerOptions = {
 /**
  * A class for shared functionality for storing, and requesting tokens.
  * Intended to be used as a parent to be extended for token request management.
- * Child classes should implement `requestToken()` to retrieve the token
- * from intended sources and `saveTokenInfo(tokenResponse)` to parse and save
+ * Child classes should implement "requestToken()" to retrieve the token
+ * from intended sources and "saveTokenInfo(tokenResponse)" to parse and save
  * token information from the response.
  */
 export declare class TokenManager {
@@ -48,40 +48,36 @@ export declare class TokenManager {
     private requestTime;
     private pendingRequests;
     /**
-     * Create a new [[TokenManager]] instance.
-     * @constructor
-     * @param {object} options Configuration options.
-     * @param {string} options.url for HTTP token requests.
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not.
-     * @param {object<string, string>} [options.headers] Headers to be sent with every
-     *   outbound HTTP requests to token services.
+     * Create a new TokenManager instance.
+     *
+     * @param options - Configuration options.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
      */
     constructor(options: TokenManagerOptions);
     /**
-     * Retrieve a new token using `requestToken()` in the case there is not a
-     *   currently stored token from a previous call, or the previous token
-     *   has expired.
+     * Retrieves a new token using "requestToken()" if there is not a
+     * currently stored token from a previous call, or the previous token
+     * has expired.
      */
     getToken(): Promise<any>;
     /**
-     * Setter for the disableSslVerification property.
+     * Sets the "disableSslVerification" property.
      *
-     * @param {boolean} value - the new value for the disableSslVerification
-     *   property
-     * @returns {void}
+     * @param value - the new value for the disableSslVerification property
      */
     setDisableSslVerification(value: boolean): void;
     /**
-     * Set a completely new set of headers.
+     * Sets the headers to be included with each outbound request to the token server.
      *
-     * @param {OutgoingHttpHeaders} headers - the new set of headers as an object
-     * @returns {void}
+     * @param headers - the set of headers to send with each request to the token server
      */
     setHeaders(headers: OutgoingHttpHeaders): void;
     /**
-     * Paces requests to request_token.
+     * Paces requests to requestToken().
      *
      * This method pseudo-serializes requests for an access_token
      * when the current token is undefined or expired.
@@ -95,7 +91,7 @@ export declare class TokenManager {
     /**
      * Request a token using an API endpoint.
      *
-     * @returns {Promise}
+     * @returns Promise
      */
     protected requestToken(): Promise<any>;
     /**
@@ -104,24 +100,16 @@ export declare class TokenManager {
      * Calculate expiration and refresh time from the received info
      * and store them in fields `expireTime` and `refreshTime`.
      *
-     * @param tokenResponse - Response object from a token service request
-     * @protected
-     * @returns {void}
+     * @param tokenResponse - the response object from a token service request
      */
     protected saveTokenInfo(tokenResponse: any): void;
     /**
-     * Check if currently stored token is expired
-     *
-     * @private
-     * @returns {boolean}
+     * Checks if currently-stored token is expired
      */
     private isTokenExpired;
     /**
-     * Check if currently stored token should be refreshed
+     * Checks if currently-stored token should be refreshed
      * i.e. past the window to request a new token
-     *
-     * @private
-     * @returns {boolean}
      */
     private tokenNeedsRefresh;
 }

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

@@ -12,21 +12,20 @@ var utils_1 = require("../utils");
 /**
  * A class for shared functionality for storing, and requesting tokens.
  * Intended to be used as a parent to be extended for token request management.
- * Child classes should implement `requestToken()` to retrieve the token
- * from intended sources and `saveTokenInfo(tokenResponse)` to parse and save
+ * Child classes should implement "requestToken()" to retrieve the token
+ * from intended sources and "saveTokenInfo(tokenResponse)" to parse and save
  * token information from the response.
  */
 var TokenManager = /** @class */ (function () {
     /**
-     * Create a new [[TokenManager]] instance.
-     * @constructor
-     * @param {object} options Configuration options.
-     * @param {string} options.url for HTTP token requests.
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not.
-     * @param {object<string, string>} [options.headers] Headers to be sent with every
-     *   outbound HTTP requests to token services.
+     * Create a new TokenManager instance.
+     *
+     * @param options - Configuration options.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
      */
     function TokenManager(options) {
         // all parameters are optional
@@ -43,9 +42,9 @@ var TokenManager = /** @class */ (function () {
         this.pendingRequests = [];
     }
     /**
-     * Retrieve a new token using `requestToken()` in the case there is not a
-     *   currently stored token from a previous call, or the previous token
-     *   has expired.
+     * Retrieves a new token using "requestToken()" if there is not a
+     * currently stored token from a previous call, or the previous token
+     * has expired.
      */
     TokenManager.prototype.getToken = function () {
         var _this = this;
@@ -63,11 +62,9 @@ var TokenManager = /** @class */ (function () {
         return Promise.resolve(this.accessToken);
     };
     /**
-     * Setter for the disableSslVerification property.
+     * Sets the "disableSslVerification" property.
      *
-     * @param {boolean} value - the new value for the disableSslVerification
-     *   property
-     * @returns {void}
+     * @param value - the new value for the disableSslVerification property
      */
     TokenManager.prototype.setDisableSslVerification = function (value) {
         // if they try to pass in a non-boolean value,
@@ -75,10 +72,9 @@ var TokenManager = /** @class */ (function () {
         this.disableSslVerification = Boolean(value);
     };
     /**
-     * Set a completely new set of headers.
+     * Sets the headers to be included with each outbound request to the token server.
      *
-     * @param {OutgoingHttpHeaders} headers - the new set of headers as an object
-     * @returns {void}
+     * @param headers - the set of headers to send with each request to the token server
      */
     TokenManager.prototype.setHeaders = function (headers) {
         if (typeof headers !== 'object') {
@@ -88,7 +84,7 @@ var TokenManager = /** @class */ (function () {
         this.headers = headers;
     };
     /**
-     * Paces requests to request_token.
+     * Paces requests to requestToken().
      *
      * This method pseudo-serializes requests for an access_token
      * when the current token is undefined or expired.
@@ -129,7 +125,7 @@ var TokenManager = /** @class */ (function () {
     /**
      * Request a token using an API endpoint.
      *
-     * @returns {Promise}
+     * @returns Promise
      */
     TokenManager.prototype.requestToken = function () {
         var errMsg = '`requestToken` MUST be overridden by a subclass of TokenManagerV1.';
@@ -143,19 +139,14 @@ var TokenManager = /** @class */ (function () {
      * Calculate expiration and refresh time from the received info
      * and store them in fields `expireTime` and `refreshTime`.
      *
-     * @param tokenResponse - Response object from a token service request
-     * @protected
-     * @returns {void}
+     * @param tokenResponse - the response object from a token service request
      */
     TokenManager.prototype.saveTokenInfo = function (tokenResponse) {
         var errMsg = '`saveTokenInfo` MUST be overridden by a subclass of TokenManager.';
         logger_1.default.error(errMsg);
     };
     /**
-     * Check if currently stored token is expired
-     *
-     * @private
-     * @returns {boolean}
+     * Checks if currently-stored token is expired
      */
     TokenManager.prototype.isTokenExpired = function () {
         var expireTime = this.expireTime;
@@ -166,11 +157,8 @@ var TokenManager = /** @class */ (function () {
         return expireTime <= currentTime;
     };
     /**
-     * Check if currently stored token should be refreshed
+     * Checks if currently-stored token should be refreshed
      * i.e. past the window to request a new token
-     *
-     * @private
-     * @returns {boolean}
      */
     TokenManager.prototype.tokenNeedsRefresh = function () {
         var refreshTime = this.refreshTime;

package/auth/token-managers/vpc-instance-token-manager.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2021.
+ * (C) Copyright IBM Corp. 2021, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,27 +28,27 @@ export declare class VpcInstanceTokenManager extends JwtTokenManager {
     private iamProfileCrn;
     private iamProfileId;
     /**
-     * Create a new [[VpcInstanceTokenManager]] instance.
+     * Create a new VpcInstanceTokenManager instance.
      *
-     * @param {object} [options] Configuration options.
-     * @param {string} [options.iamProfileCrn] The CRN of the linked trusted IAM profile to be used as the identity of the compute resource.
-     *    At most one of iamProfileCrn or iamProfileId may be specified.
-     *    If neither one is specified, then the default IAM profile defined for the compute resource will be used.
-     * @param {string} [options.iamProfileId] The ID of the linked trusted IAM profile to be used when obtaining the IAM access token.
-     *    At most one of iamProfileCrn or iamProfileId may be specified.
-     *    If neither one is specified, then the default IAM profile defined for the compute resource will be used.
-     * @param {string} [options.url] The VPC Instance Metadata Service's base endpoint URL. Default value: "http://169.254.169.254"
-     * @constructor
+     * @param options - Configuration options.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the VPC Instance Metadata Service (default value: "http://169.254.169.254")
+     * - iamProfileCrn: (optional) the CRN of the linked IAM trusted profile to be used to obtain the IAM access token
+     * - iamProfileId: (optional) the ID of the linked IAM trusted profile to be used to obtain the IAM access token
+     *
+     * @remarks
+     * At most one of "iamProfileCrn" or "iamProfileId" may be specified. If neither one is specified,
+     * then the default IAM profile defined for the compute resource will be used.
      */
     constructor(options: Options);
     /**
-     * Setter for the "trusted_profile" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} iamProfileCrn A string that makes up the iamProfileCrn parameter
+     * Sets the CRN of the IAM trusted profile to use when fetching the access token from the IAM token server.
+     * @param iamProfileCrn - the CRN of the IAM trusted profile
      */
     setIamProfileCrn(iamProfileCrn: string): void;
     /**
-     * Setter for the "trusted_profile" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} iamProfileId A string that makes up the iamProfileId parameter
+     * Sets the Id of the IAM trusted profile to use when fetching the access token from the IAM token server.
+     * @param iamProfileId - the ID of the IAM trusted profile
      */
     setIamProfileId(iamProfileId: string): void;
     protected requestToken(): Promise<any>;