ibm-cloud-sdk-core 4.0.0 → 4.0.2

package/es/auth/authenticators/iam-authenticator.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,15 +21,15 @@ export interface Options extends IamRequestOptions {
     apikey: string;
 }
 /**
- * The [[IamAuthenticator]] will use the user-supplied `apikey`
- * values to obtain a bearer token from a token server.  When the bearer token
+ * The IamAuthenticator will use the user-supplied `apikey`
+ * value to obtain a bearer token from a token server.  When the bearer token
  * expires, a new token is obtained from the token server. If specified, the
- * optional, mutually inclusive `clientId` and`clientSecret` pair can be used to
+ * optional, mutually inclusive "clientId" and "clientSecret" pair can be used to
  * influence rate-limiting for requests to the IAM token server.
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export declare class IamAuthenticator extends IamRequestBasedAuthenticator {
     protected requiredOptions: string[];
@@ -37,22 +37,22 @@ export declare class IamAuthenticator extends IamRequestBasedAuthenticator {
     private apikey;
     /**
      *
-     * Create a new [[IamAuthenticator]] instance.
+     * Create a new IamAuthenticator instance.
      *
-     * @param {object} options Configuration options for IAM authentication.
-     * @param {boolean} options.disableSslVerification A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {string} options.url for HTTP token requests.
-     * @param {object<string, string>} options.headers to be sent with every
-     * @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} [options.scope] The "scope" parameter to use when fetching the bearer token from the
-     *   IAM token server.
-     * @throws {Error} When the configuration options are not valid.
+     * @param options - Configuration options for IAM authentication.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - 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/es/auth/authenticators/iam-authenticator.js

@@ -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.
@@ -18,35 +18,35 @@ import { IamTokenManager } from '../token-managers';
 import { validateInput } from '../utils';
 import { IamRequestBasedAuthenticator } from './iam-request-based-authenticator';
 /**
- * The [[IamAuthenticator]] will use the user-supplied `apikey`
- * values to obtain a bearer token from a token server.  When the bearer token
+ * The IamAuthenticator will use the user-supplied `apikey`
+ * value to obtain a bearer token from a token server.  When the bearer token
  * expires, a new token is obtained from the token server. If specified, the
- * optional, mutually inclusive `clientId` and`clientSecret` pair can be used to
+ * optional, mutually inclusive "clientId" and "clientSecret" pair can be used to
  * influence rate-limiting for requests to the IAM token server.
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export class IamAuthenticator extends IamRequestBasedAuthenticator {
     /**
      *
-     * Create a new [[IamAuthenticator]] instance.
+     * Create a new IamAuthenticator instance.
      *
-     * @param {object} options Configuration options for IAM authentication.
-     * @param {boolean} options.disableSslVerification A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {string} options.url for HTTP token requests.
-     * @param {object<string, string>} options.headers to be sent with every
-     * @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} [options.scope] The "scope" parameter to use when fetching the bearer token from the
-     *   IAM token server.
-     * @throws {Error} When the configuration options are not valid.
+     * @param options - Configuration options for IAM authentication.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - 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) {
         super(options);

package/es/auth/authenticators/iam-request-based-authenticator.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.
@@ -33,8 +33,8 @@ export interface IamRequestOptions extends BaseOptions {
     scope?: string;
 }
 /**
- * The [[IamRequestBasedAuthenticator]] provides shared configuration and functionality
- * for authenticators that interact with the IAM service to inherit. This authenticator
+ * The IamRequestBasedAuthenticator provides shared configuration and functionality
+ * for authenticators that interact with the IAM token service. This authenticator
  * is not meant for use on its own.
  */
 export declare class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator {
@@ -44,41 +44,39 @@ export declare class IamRequestBasedAuthenticator extends TokenRequestBasedAuthe
     protected scope: string;
     /**
      *
-     * Create a new [[IamRequestBasedAuthenticator]] instance.
+     * Create a new IamRequestBasedAuthenticator instance.
      *
-     * @param {object} options Configuration options for IAM authentication.
-     * @param {boolean} options.disableSslVerification A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {string} options.url for HTTP token requests.
-     * @param {object<string, string>} options.headers to be sent with every IAM token request
-     * @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} [options.scope] The "scope" parameter to use when fetching the bearer token from the
-     *   IAM token server.
-     * @throws {Error} When the configuration options are not valid.
+     * @param options - Configuration options for IAM authentication.
+     * 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
+     * - 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: IamRequestOptions);
     /**
-     * Setter for the mutually inclusive `clientId` and the `clientSecret`.
-     * @param {string} clientId The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} clientSecret The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
+     * Setter for the mutually inclusive "clientId" and the "clientSecret" fields.
+     * @param clientId - the "clientId" value used to form a Basic Authorization header for IAM token requests
+     * @param clientSecret - the "clientSecret" value used to form a Basic Authorization header for IAM token requests
      */
     setClientIdAndSecret(clientId: string, clientSecret: string): void;
     /**
      * Setter for the "scope" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} scope A space seperated string that makes up the scope parameter
+     * @param scope - (optional) a space-separated string that specifies one or more scopes to be
+     * associated with IAM token requests
      */
     setScope(scope: string): void;
     /**
      * Return the most recently stored refresh token.
      *
-     * @public
-     * @returns {string}
+     * @returns the refresh token string
      */
     getRefreshToken(): string;
 }

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

@@ -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.
@@ -16,28 +16,28 @@
 import { IamRequestBasedTokenManager } from '../token-managers';
 import { TokenRequestBasedAuthenticator } from './token-request-based-authenticator';
 /**
- * The [[IamRequestBasedAuthenticator]] provides shared configuration and functionality
- * for authenticators that interact with the IAM service to inherit. This authenticator
+ * The IamRequestBasedAuthenticator provides shared configuration and functionality
+ * for authenticators that interact with the IAM token service. This authenticator
  * is not meant for use on its own.
  */
 export class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator {
     /**
      *
-     * Create a new [[IamRequestBasedAuthenticator]] instance.
+     * Create a new IamRequestBasedAuthenticator instance.
      *
-     * @param {object} options Configuration options for IAM authentication.
-     * @param {boolean} options.disableSslVerification A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {string} options.url for HTTP token requests.
-     * @param {object<string, string>} options.headers to be sent with every IAM token request
-     * @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} [options.scope] The "scope" parameter to use when fetching the bearer token from the
-     *   IAM token server.
-     * @throws {Error} When the configuration options are not valid.
+     * @param options - Configuration options for IAM authentication.
+     * 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
+     * - 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) {
         // all parameters are optional
@@ -49,11 +49,9 @@ export class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator
         this.tokenManager = new IamRequestBasedTokenManager(options);
     }
     /**
-     * Setter for the mutually inclusive `clientId` and the `clientSecret`.
-     * @param {string} clientId The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} clientSecret The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
+     * Setter for the mutually inclusive "clientId" and the "clientSecret" fields.
+     * @param clientId - the "clientId" value used to form a Basic Authorization header for IAM token requests
+     * @param clientSecret - the "clientSecret" value used to form a Basic Authorization header for IAM token requests
      */
     setClientIdAndSecret(clientId, clientSecret) {
         this.clientId = clientId;
@@ -63,7 +61,8 @@ export class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator
     }
     /**
      * Setter for the "scope" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} scope A space seperated string that makes up the scope parameter
+     * @param scope - (optional) a space-separated string that specifies one or more scopes to be
+     * associated with IAM token requests
      */
     setScope(scope) {
         this.scope = scope;
@@ -73,8 +72,7 @@ export class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator
     /**
      * Return the most recently stored refresh token.
      *
-     * @public
-     * @returns {string}
+     * @returns the refresh token string
      */
     getRefreshToken() {
         return this.tokenManager.getRefreshToken();

package/es/auth/authenticators/token-request-based-authenticator.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.
@@ -34,14 +34,14 @@ export type BaseOptions = {
 };
 /**
  * Class for common functionality shared by token-request authenticators.
- * [[TokenRequestBasedAuthenticator]]s use token managers to retrieve, store,
+ * TokenRequestBasedAuthenticators use token managers to retrieve, store,
  * and refresh tokens. Not intended to be used as stand-alone authenticator,
- * but as parent class to authenticators that have their own token manager
+ * but as base class to authenticators that have their own token manager
  * implementations.
  *
- * The tokens will be added as an Authorization headers in the form:
+ * The token will be added as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export declare class TokenRequestBasedAuthenticator extends Authenticator {
     protected tokenManager: JwtTokenManager;
@@ -49,43 +49,38 @@ export declare class TokenRequestBasedAuthenticator extends Authenticator {
     protected headers: OutgoingHttpHeaders;
     protected disableSslVerification: boolean;
     /**
-     * Create a new [[TokenRequestBasedAuthenticator]] instance with an internal [[JwtTokenManager]].
+     * Create a new TokenRequestBasedAuthenticator instance with an internal JwtTokenManager.
      *
-     * @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] to be sent with every
-     *   outbound HTTP requests to token services.
+     * @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: BaseOptions);
     /**
      * Set the flag that indicates whether verification of the server's SSL
      * certificate should be disabled or not.
      *
-     * @param {boolean} value A flag that indicates whether verification of the
+     * @param value - a flag that indicates whether verification of the
      *   token server's SSL certificate should be disabled or not.
      */
     setDisableSslVerification(value: boolean): void;
     /**
      * Set headers.
      *
-     * @param {object<string, string>} headers Default headers to be sent with
-     *   every Cloud Pak For Data token request. Overwrites previous default headers.
+     * @param headers - a set of HTTP headers to be sent with each outbound token server request.
+     * Overwrites previous default headers.
      */
     setHeaders(headers: OutgoingHttpHeaders): void;
     /**
-     * Adds bearer token information to `request`. The bearer token information
-     * will be set in the Authorization property of`request.headers` in the form:
+     * Adds bearer token information to "requestOptions". The bearer token information
+     * will be set in the Authorization property of "requestOptions.headers" in the form:
      *
-     *     Authorization: Bearer <bearer-token>
+     *     Authorization: Bearer \<bearer-token\>
      *
-     * @param {object} requestOptions - The request to augment with authentication
-     *   information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added too. Overrides default headers
-     *   where there's conflict.
+     * @param requestOptions - The request to augment with authentication information.
      */
     authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 }

package/es/auth/authenticators/token-request-based-authenticator.js

@@ -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.
@@ -18,26 +18,25 @@ import { JwtTokenManager } from '../token-managers';
 import { Authenticator } from './authenticator';
 /**
  * Class for common functionality shared by token-request authenticators.
- * [[TokenRequestBasedAuthenticator]]s use token managers to retrieve, store,
+ * TokenRequestBasedAuthenticators use token managers to retrieve, store,
  * and refresh tokens. Not intended to be used as stand-alone authenticator,
- * but as parent class to authenticators that have their own token manager
+ * but as base class to authenticators that have their own token manager
  * implementations.
  *
- * The tokens will be added as an Authorization headers in the form:
+ * The token will be added as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export class TokenRequestBasedAuthenticator extends Authenticator {
     /**
-     * Create a new [[TokenRequestBasedAuthenticator]] instance with an internal [[JwtTokenManager]].
+     * Create a new TokenRequestBasedAuthenticator instance with an internal JwtTokenManager.
      *
-     * @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] to be sent with every
-     *   outbound HTTP requests to token services.
+     * @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) {
         super();
@@ -51,7 +50,7 @@ export class TokenRequestBasedAuthenticator extends Authenticator {
      * Set the flag that indicates whether verification of the server's SSL
      * certificate should be disabled or not.
      *
-     * @param {boolean} value A flag that indicates whether verification of the
+     * @param value - a flag that indicates whether verification of the
      *   token server's SSL certificate should be disabled or not.
      */
     setDisableSslVerification(value) {
@@ -63,8 +62,8 @@ export class TokenRequestBasedAuthenticator extends Authenticator {
     /**
      * Set headers.
      *
-     * @param {object<string, string>} headers Default headers to be sent with
-     *   every Cloud Pak For Data token request. Overwrites previous default headers.
+     * @param headers - a set of HTTP headers to be sent with each outbound token server request.
+     * Overwrites previous default headers.
      */
     setHeaders(headers) {
         if (typeof headers !== 'object') {
@@ -75,16 +74,12 @@ export class TokenRequestBasedAuthenticator extends Authenticator {
         this.tokenManager.setHeaders(this.headers);
     }
     /**
-     * Adds bearer token information to `request`. The bearer token information
-     * will be set in the Authorization property of`request.headers` in the form:
+     * Adds bearer token information to "requestOptions". The bearer token information
+     * will be set in the Authorization property of "requestOptions.headers" in the form:
      *
-     *     Authorization: Bearer <bearer-token>
+     *     Authorization: Bearer \<bearer-token\>
      *
-     * @param {object} requestOptions - The request to augment with authentication
-     *   information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added too. Overrides default headers
-     *   where there's conflict.
+     * @param requestOptions - The request to augment with authentication information.
      */
     authenticate(requestOptions) {
         return this.tokenManager.getToken().then((token) => {

package/es/auth/authenticators/vpc-instance-authenticator.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.
@@ -23,40 +23,41 @@ export interface Options extends BaseOptions {
     iamProfileId?: string;
 }
 /**
- * The [[VpcInstanceAuthenticator]] implements an authentication scheme in which it retrieves an "instance identity token"
+ * The VpcInstanceAuthenticator implements an authentication scheme in which it retrieves an "instance identity token"
  * and exchanges that for an IAM access token using the VPC Instance Metadata Service API which is available on the local
  * compute resource (VM). The instance identity token is similar to an IAM apikey, except that it is managed automatically
  * by the compute resource provider (VPC).
  *
  * The resulting IAM access token is then added to outbound requests in an Authorization header
  *
- *      Authorization: Bearer <access-token>
+ *      Authorization: Bearer \<access-token\>
  */
 export declare class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator {
     protected tokenManager: VpcInstanceTokenManager;
     private iamProfileCrn;
     private iamProfileId;
     /**
-     * Create a new [[VpcInstanceAuthenticator]] instance.
+     * Create a new VpcInstanceAuthenticator instance.
      *
-     * @param {object} [options] Configuration options for VpcInstance authentication.
-     * @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"
+     * @param options - Configuration options for VpcInstance authentication.
+     * 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 "profile_crn" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileCrn parameter
+     * Sets the "iamProfileCrn" value to be used when obtaining an IAM access token
+     * @param iamProfileCrn - the CRN of the linked IAM trusted profile to use when obtaining an IAM access token
      */
     setIamProfileCrn(iamProfileCrn: string): void;
     /**
-     * Setter for the "profile_id" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileId parameter
+     * Sets the "iamProfileId" value to be used when obtaining an IAM access token
+     * @param iamProfileId - the ID of the linked IAM trusted profile to use when obtaining an IAM access token
      */
     setIamProfileId(iamProfileId: string): void;
     /**

package/es/auth/authenticators/vpc-instance-authenticator.js

@@ -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.
@@ -17,27 +17,28 @@ import { Authenticator } from './authenticator';
 import { VpcInstanceTokenManager } from '../token-managers';
 import { TokenRequestBasedAuthenticator } from './token-request-based-authenticator';
 /**
- * The [[VpcInstanceAuthenticator]] implements an authentication scheme in which it retrieves an "instance identity token"
+ * The VpcInstanceAuthenticator implements an authentication scheme in which it retrieves an "instance identity token"
  * and exchanges that for an IAM access token using the VPC Instance Metadata Service API which is available on the local
  * compute resource (VM). The instance identity token is similar to an IAM apikey, except that it is managed automatically
  * by the compute resource provider (VPC).
  *
  * The resulting IAM access token is then added to outbound requests in an Authorization header
  *
- *      Authorization: Bearer <access-token>
+ *      Authorization: Bearer \<access-token\>
  */
 export class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator {
     /**
-     * Create a new [[VpcInstanceAuthenticator]] instance.
+     * Create a new VpcInstanceAuthenticator instance.
      *
-     * @param {object} [options] Configuration options for VpcInstance authentication.
-     * @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"
+     * @param options - Configuration options for VpcInstance authentication.
+     * 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) {
         // all parameters are optional
@@ -55,8 +56,8 @@ export class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator {
         this.tokenManager = new VpcInstanceTokenManager(options);
     }
     /**
-     * Setter for the "profile_crn" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileCrn parameter
+     * Sets the "iamProfileCrn" value to be used when obtaining an IAM access token
+     * @param iamProfileCrn - the CRN of the linked IAM trusted profile to use when obtaining an IAM access token
      */
     setIamProfileCrn(iamProfileCrn) {
         this.iamProfileCrn = iamProfileCrn;
@@ -64,8 +65,8 @@ export class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator {
         this.tokenManager.setIamProfileCrn(iamProfileCrn);
     }
     /**
-     * Setter for the "profile_id" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileId parameter
+     * Sets the "iamProfileId" value to be used when obtaining an IAM access token
+     * @param iamProfileId - the ID of the linked IAM trusted profile to use when obtaining an IAM access token
      */
     setIamProfileId(iamProfileId) {
         this.iamProfileId = iamProfileId;