ibm-cloud-sdk-core 4.0.0 → 4.0.2

package/build/docs/ibm-cloud-sdk-core.tokenmanager._constructor_.md

@@ -4,7 +4,7 @@
 
 ## TokenManager.(constructor)
 
-Create a new \[\[TokenManager\]\] instance. 
+Create a new TokenManager instance.
 
 <b>Signature:</b>
 
@@ -16,5 +16,5 @@ constructor(options: TokenManagerOptions);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [TokenManagerOptions](./ibm-cloud-sdk-core.tokenmanageroptions.md) | Configuration options. |
+|  options | [TokenManagerOptions](./ibm-cloud-sdk-core.tokenmanageroptions.md) | 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 |
 

package/build/docs/ibm-cloud-sdk-core.tokenmanager.gettoken.md

@@ -4,7 +4,7 @@
 
 ## TokenManager.getToken() method
 
-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.
 
 <b>Signature:</b>
 

package/build/docs/ibm-cloud-sdk-core.tokenmanager.md

@@ -4,7 +4,7 @@
 
 ## TokenManager class
 
-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 token information from the response.
+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 token information from the response.
 
 <b>Signature:</b>
 
@@ -16,28 +16,28 @@ export declare class TokenManager
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.tokenmanager._constructor_.md) |  | Create a new \[\[TokenManager\]\] instance.  |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.tokenmanager._constructor_.md) |  | Create a new TokenManager instance. |
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [accessToken](./ibm-cloud-sdk-core.tokenmanager.accesstoken.md) |  | string |  |
-|  [disableSslVerification](./ibm-cloud-sdk-core.tokenmanager.disablesslverification.md) |  | boolean |  |
-|  [expireTime](./ibm-cloud-sdk-core.tokenmanager.expiretime.md) |  | number |  |
-|  [headers](./ibm-cloud-sdk-core.tokenmanager.headers.md) |  | OutgoingHttpHeaders |  |
-|  [refreshTime](./ibm-cloud-sdk-core.tokenmanager.refreshtime.md) |  | number |  |
-|  [requestWrapperInstance](./ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.md) |  | RequestWrapper |  |
-|  [url](./ibm-cloud-sdk-core.tokenmanager.url.md) |  | string |  |
+|  [accessToken](./ibm-cloud-sdk-core.tokenmanager.accesstoken.md) | <code>protected</code> | string |  |
+|  [disableSslVerification](./ibm-cloud-sdk-core.tokenmanager.disablesslverification.md) | <code>protected</code> | boolean |  |
+|  [expireTime](./ibm-cloud-sdk-core.tokenmanager.expiretime.md) | <code>protected</code> | number |  |
+|  [headers](./ibm-cloud-sdk-core.tokenmanager.headers.md) | <code>protected</code> | OutgoingHttpHeaders |  |
+|  [refreshTime](./ibm-cloud-sdk-core.tokenmanager.refreshtime.md) | <code>protected</code> | number |  |
+|  [requestWrapperInstance](./ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.md) | <code>protected</code> | RequestWrapper |  |
+|  [url](./ibm-cloud-sdk-core.tokenmanager.url.md) | <code>protected</code> | string |  |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [getToken()](./ibm-cloud-sdk-core.tokenmanager.gettoken.md) |  | Retrieve a new token using <code>requestToken()</code> in the case there is not a currently stored token from a previous call, or the previous token has expired. |
-|  [pacedRequestToken()](./ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md) |  | Paces requests to request\_token.<!-- -->This method pseudo-serializes requests for an access\_token when the current token is undefined or expired. The first caller to this method records its <code>requestTime</code> and then issues the token request. Subsequent callers will check the <code>requestTime</code> to see if a request is active (has been issued within the past 60 seconds), and if so will queue their promise for the active requestor to resolve when that request completes. |
-|  [requestToken()](./ibm-cloud-sdk-core.tokenmanager.requesttoken.md) |  | Request a token using an API endpoint. |
-|  [saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md) |  | Parse and save token information from the response. Save the requested token into field <code>accessToken</code>. Calculate expiration and refresh time from the received info and store them in fields <code>expireTime</code> and <code>refreshTime</code>. |
-|  [setDisableSslVerification(value)](./ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md) |  | Setter for the disableSslVerification property. |
-|  [setHeaders(headers)](./ibm-cloud-sdk-core.tokenmanager.setheaders.md) |  | Set a completely new set of headers. |
+|  [getToken()](./ibm-cloud-sdk-core.tokenmanager.gettoken.md) |  | Retrieves a new token using "requestToken()" if there is not a currently stored token from a previous call, or the previous token has expired. |
+|  [pacedRequestToken()](./ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md) | <code>protected</code> | <p>Paces requests to requestToken().</p><p>This method pseudo-serializes requests for an access\_token when the current token is undefined or expired. The first caller to this method records its <code>requestTime</code> and then issues the token request. Subsequent callers will check the <code>requestTime</code> to see if a request is active (has been issued within the past 60 seconds), and if so will queue their promise for the active requestor to resolve when that request completes.</p> |
+|  [requestToken()](./ibm-cloud-sdk-core.tokenmanager.requesttoken.md) | <code>protected</code> | Request a token using an API endpoint. |
+|  [saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md) | <code>protected</code> | Parse and save token information from the response. Save the requested token into field <code>accessToken</code>. Calculate expiration and refresh time from the received info and store them in fields <code>expireTime</code> and <code>refreshTime</code>. |
+|  [setDisableSslVerification(value)](./ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md) |  | Sets the "disableSslVerification" property. |
+|  [setHeaders(headers)](./ibm-cloud-sdk-core.tokenmanager.setheaders.md) |  | Sets the headers to be included with each outbound request to the token server. |
 

package/build/docs/ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md

@@ -4,7 +4,7 @@
 
 ## TokenManager.pacedRequestToken() method
 
-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. The first caller to this method records its `requestTime` and then issues the token request. Subsequent callers will check the `requestTime` to see if a request is active (has been issued within the past 60 seconds), and if so will queue their promise for the active requestor to resolve when that request completes.
 

package/build/docs/ibm-cloud-sdk-core.tokenmanager.requesttoken.md

@@ -15,5 +15,5 @@ protected requestToken(): Promise<any>;
 
 Promise&lt;any&gt;
 
-{<!-- -->Promise<!-- -->}
+Promise
 

package/build/docs/ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md

@@ -16,11 +16,9 @@ protected saveTokenInfo(tokenResponse: any): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  tokenResponse | any | Response object from a token service request  |
+|  tokenResponse | any | the response object from a token service request |
 
 <b>Returns:</b>
 
 void
 
-{<!-- -->void<!-- -->}
-

package/build/docs/ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md

@@ -4,7 +4,7 @@
 
 ## TokenManager.setDisableSslVerification() method
 
-Setter for the disableSslVerification property.
+Sets the "disableSslVerification" property.
 
 <b>Signature:</b>
 
@@ -22,5 +22,3 @@ setDisableSslVerification(value: boolean): void;
 
 void
 
-{<!-- -->void<!-- -->}
-

package/build/docs/ibm-cloud-sdk-core.tokenmanager.setheaders.md

@@ -4,7 +4,7 @@
 
 ## TokenManager.setHeaders() method
 
-Set a completely new set of headers.
+Sets the headers to be included with each outbound request to the token server.
 
 <b>Signature:</b>
 
@@ -16,11 +16,9 @@ setHeaders(headers: OutgoingHttpHeaders): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  headers | OutgoingHttpHeaders | the new set of headers as an object |
+|  headers | OutgoingHttpHeaders | the set of headers to send with each request to the token server |
 
 <b>Returns:</b>
 
 void
 
-{<!-- -->void<!-- -->}
-

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator._constructor_.md

@@ -4,7 +4,7 @@
 
 ## TokenRequestBasedAuthenticator.(constructor)
 
-Create a new \[\[TokenRequestBasedAuthenticator\]\] instance with an internal \[\[JwtTokenManager\]\].
+Create a new TokenRequestBasedAuthenticator instance with an internal JwtTokenManager.
 
 <b>Signature:</b>
 
@@ -16,5 +16,5 @@ constructor(options: BaseOptions);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | BaseOptions | Configuration options. |
+|  options | BaseOptions | 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 |
 

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md

@@ -4,9 +4,9 @@
 
 ## TokenRequestBasedAuthenticator.authenticate() method
 
-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 &lt;<!-- -->bearer-token<!-- -->&gt;
 
 <b>Signature:</b>
 

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md

@@ -4,11 +4,11 @@
 
 ## TokenRequestBasedAuthenticator class
 
-Class for common functionality shared by token-request authenticators. \[\[TokenRequestBasedAuthenticator\]\]s 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 implementations.
+Class for common functionality shared by token-request authenticators. TokenRequestBasedAuthenticators use token managers to retrieve, store, and refresh tokens. Not intended to be used as stand-alone authenticator, 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 &lt;<!-- -->bearer-token<!-- -->&gt;
 
 <b>Signature:</b>
 
@@ -21,22 +21,22 @@ export declare class TokenRequestBasedAuthenticator extends Authenticator
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator._constructor_.md) |  | Create a new \[\[TokenRequestBasedAuthenticator\]\] instance with an internal \[\[JwtTokenManager\]\]. |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator._constructor_.md) |  | Create a new TokenRequestBasedAuthenticator instance with an internal JwtTokenManager. |
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [disableSslVerification](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.md) |  | boolean |  |
-|  [headers](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.md) |  | OutgoingHttpHeaders |  |
-|  [tokenManager](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.tokenmanager.md) |  | [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) |  |
-|  [url](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.url.md) |  | string |  |
+|  [disableSslVerification](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.md) | <code>protected</code> | boolean |  |
+|  [headers](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.md) | <code>protected</code> | OutgoingHttpHeaders |  |
+|  [tokenManager](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.tokenmanager.md) | <code>protected</code> | [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md) |  |
+|  [url](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.url.md) | <code>protected</code> | string |  |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md) |  | Adds bearer token information to <code>request</code>. The bearer token information will be set in the Authorization property of<code>request.headers</code> in the form:<!-- -->Authorization: Bearer <bearer-token> |
+|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md) |  | <p>Adds bearer token information to "requestOptions". The bearer token information will be set in the Authorization property of "requestOptions.headers" in the form:</p><p>Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;</p> |
 |  [setDisableSslVerification(value)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md) |  | Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not. |
 |  [setHeaders(headers)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md) |  | Set headers. |
 

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md

@@ -16,7 +16,7 @@ setDisableSslVerification(value: boolean): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  value | boolean | A flag that indicates whether verification of the token server's SSL certificate should be disabled or not. |
+|  value | boolean | a flag that indicates whether verification of the token server's SSL certificate should be disabled or not. |
 
 <b>Returns:</b>
 

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md

@@ -16,7 +16,7 @@ setHeaders(headers: OutgoingHttpHeaders): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  headers | OutgoingHttpHeaders | Default headers to be sent with every Cloud Pak For Data token request. Overwrites previous default headers. |
+|  headers | OutgoingHttpHeaders | a set of HTTP headers to be sent with each outbound token server request. Overwrites previous default headers. |
 
 <b>Returns:</b>
 

package/build/docs/ibm-cloud-sdk-core.tolowerkeys.md

@@ -22,5 +22,5 @@ export declare function toLowerKeys(obj: Object): Object;
 
 Object
 
-{<!-- -->Object<!-- -->}
+the object with keys folded to lowercase
 

package/build/docs/ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md

@@ -22,5 +22,3 @@ export declare function checkForSuccessfulExecution(createRequestMock: any): voi
 
 void
 
-{<!-- -->void<!-- -->}
-

package/build/docs/ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md

@@ -24,5 +24,3 @@ export declare function checkMediaHeaders(createRequestMock: any, accept: string
 
 void
 
-{<!-- -->void<!-- -->}
-

package/build/docs/ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md

@@ -18,11 +18,9 @@ export declare function checkUrlAndMethod(options: any, url: string, method: any
 |  --- | --- | --- |
 |  options | any | the options object put together by the SDK, retrieved from the createRequest mock |
 |  url | string | The URL path of the service endpoint, from the paths section of the API definition |
-|  method | any |  |
+|  method | any | The HTTP method for the request, from the API definition |
 
 <b>Returns:</b>
 
 void
 
-{<!-- -->void<!-- -->}
-

package/build/docs/ibm-cloud-sdk-core.unittestutils.checkuserheader.md

@@ -24,5 +24,3 @@ export declare function checkUserHeader(createRequestMock: any, userHeaderName:
 
 void
 
-{<!-- -->void<!-- -->}
-

package/build/docs/ibm-cloud-sdk-core.unittestutils.expecttobepromise.md

@@ -22,5 +22,3 @@ export declare function expectToBePromise(sdkPromise: any): void;
 
 void
 
-{<!-- -->void<!-- -->}
-

package/build/docs/ibm-cloud-sdk-core.unittestutils.getoptions.md

@@ -22,5 +22,5 @@ export declare function getOptions(createRequestMock: any): any;
 
 any
 
-{<!-- -->Object<!-- -->}
+Object
 

package/build/docs/ibm-cloud-sdk-core.useroptions.md

@@ -14,13 +14,13 @@ export interface UserOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [authenticator?](./ibm-cloud-sdk-core.useroptions.authenticator.md) | [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) | <i>(Optional)</i> The Authenticator object used to authenticate requests to the service |
-|  [disableSslVerification?](./ibm-cloud-sdk-core.useroptions.disablesslverification.md) | boolean | <i>(Optional)</i> Set to <code>true</code> to allow unauthorized requests - not recommended for production use. |
-|  [headers?](./ibm-cloud-sdk-core.useroptions.headers.md) | OutgoingHttpHeaders | <i>(Optional)</i> Default headers that shall be included with every request to the service. |
-|  [jar?](./ibm-cloud-sdk-core.useroptions.jar.md) | CookieJar \| boolean | <i>(Optional)</i> Set your own cookie jar object |
-|  [serviceUrl?](./ibm-cloud-sdk-core.useroptions.serviceurl.md) | string | <i>(Optional)</i> The base url to use when contacting the service. The base url may differ between IBM Cloud regions. |
-|  [url?](./ibm-cloud-sdk-core.useroptions.url.md) | string | <i>(Optional)</i> Deprecated. Use <code>serviceUrl</code> instead. |
-|  [version?](./ibm-cloud-sdk-core.useroptions.version.md) | string | <i>(Optional)</i> The API version date to use with the service, in "YYYY-MM-DD" format. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [authenticator?](./ibm-cloud-sdk-core.useroptions.authenticator.md) |  | [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) | <i>(Optional)</i> The Authenticator object used to authenticate requests to the service |
+|  [disableSslVerification?](./ibm-cloud-sdk-core.useroptions.disablesslverification.md) |  | boolean | <i>(Optional)</i> Set to <code>true</code> to allow unauthorized requests - not recommended for production use. |
+|  [headers?](./ibm-cloud-sdk-core.useroptions.headers.md) |  | OutgoingHttpHeaders | <i>(Optional)</i> Default headers that shall be included with every request to the service. |
+|  [jar?](./ibm-cloud-sdk-core.useroptions.jar.md) |  | CookieJar \| boolean | <i>(Optional)</i> Set your own cookie jar object |
+|  [serviceUrl?](./ibm-cloud-sdk-core.useroptions.serviceurl.md) |  | string | <i>(Optional)</i> The base url to use when contacting the service. The base url may differ between IBM Cloud regions. |
+|  [url?](./ibm-cloud-sdk-core.useroptions.url.md) |  | string | <i>(Optional)</i> Deprecated. Use <code>serviceUrl</code> instead. |
+|  [version?](./ibm-cloud-sdk-core.useroptions.version.md) |  | string | <i>(Optional)</i> The API version date to use with the service, in "YYYY-MM-DD" format. |
 

package/build/docs/ibm-cloud-sdk-core.validateinput.md

@@ -4,6 +4,8 @@
 
 ## validateInput() function
 
+Validates "options".
+
 <b>Signature:</b>
 
 ```typescript
@@ -14,10 +16,14 @@ export declare function validateInput(options: any, requiredOptions: string[]):
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | any | A configuration options object. |
-|  requiredOptions | string\[\] | The list of properties that must be specified. |
+|  options | any | a configuration options object |
+|  requiredOptions | string\[\] | the list of properties that must be present in "options" |
 
 <b>Returns:</b>
 
 void
 
+## Exceptions
+
+Error: "options" failed validation
+

package/build/docs/ibm-cloud-sdk-core.validateparams.md

@@ -26,5 +26,5 @@ export declare function validateParams(params: {
 
 null \| Error
 
-{<!-- -->Error\|null<!-- -->}
+null if no errors found, otherwise an Error instance
 

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md

@@ -4,7 +4,7 @@
 
 ## VpcInstanceAuthenticator.(constructor)
 
-Create a new \[\[VpcInstanceAuthenticator\]\] instance.
+Create a new VpcInstanceAuthenticator instance.
 
 <b>Signature:</b>
 
@@ -16,5 +16,9 @@ constructor(options: Options);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | Options | Configuration options for VpcInstance authentication. |
+|  options | 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.
 

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.md

@@ -4,11 +4,11 @@
 
 ## VpcInstanceAuthenticator class
 
-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 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 &lt;<!-- -->access-token<!-- -->&gt;
 
 <b>Signature:</b>
 
@@ -21,19 +21,19 @@ export declare class VpcInstanceAuthenticator extends TokenRequestBasedAuthentic
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md) |  | Create a new \[\[VpcInstanceAuthenticator\]\] instance. |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md) |  | Create a new VpcInstanceAuthenticator instance. |
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [tokenManager](./ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md) |  | [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) |  |
+|  [tokenManager](./ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md) | <code>protected</code> | [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) |  |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [authenticationType()](./ibm-cloud-sdk-core.vpcinstanceauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('vpc'). |
-|  [setIamProfileCrn(iamProfileCrn)](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md) |  | Setter for the "profile\_crn" parameter to use when fetching the bearer token from the IAM token server. |
-|  [setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md) |  | Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server. |
+|  [setIamProfileCrn(iamProfileCrn)](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md) |  | Sets the "iamProfileCrn" value to be used when obtaining an IAM access token |
+|  [setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md) |  | Sets the "iamProfileId" value to be used when obtaining an IAM access token |
 

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md

@@ -4,7 +4,7 @@
 
 ## VpcInstanceAuthenticator.setIamProfileCrn() method
 
-Setter for the "profile\_crn" parameter to use when fetching the bearer token from the IAM token server.
+Sets the "iamProfileCrn" value to be used when obtaining an IAM access token
 
 <b>Signature:</b>
 
@@ -16,7 +16,7 @@ setIamProfileCrn(iamProfileCrn: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  iamProfileCrn | string |  |
+|  iamProfileCrn | string | the CRN of the linked IAM trusted profile to use when obtaining an IAM access token |
 
 <b>Returns:</b>
 

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md

@@ -4,7 +4,7 @@
 
 ## VpcInstanceAuthenticator.setIamProfileId() method
 
-Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server.
+Sets the "iamProfileId" value to be used when obtaining an IAM access token
 
 <b>Signature:</b>
 
@@ -16,7 +16,7 @@ setIamProfileId(iamProfileId: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  iamProfileId | string |  |
+|  iamProfileId | string | the ID of the linked IAM trusted profile to use when obtaining an IAM access token |
 
 <b>Returns:</b>
 

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md

@@ -4,7 +4,7 @@
 
 ## VpcInstanceTokenManager.(constructor)
 
-Create a new \[\[VpcInstanceTokenManager\]\] instance.
+Create a new VpcInstanceTokenManager instance.
 
 <b>Signature:</b>
 
@@ -16,5 +16,9 @@ constructor(options: Options);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | Options | Configuration options. |
+|  options | 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.
 

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.md

@@ -17,13 +17,13 @@ export declare class VpcInstanceTokenManager extends JwtTokenManager
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(options)](./ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md) |  | Create a new \[\[VpcInstanceTokenManager\]\] instance. |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md) |  | Create a new VpcInstanceTokenManager instance. |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [requestToken()](./ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md) |  |  |
-|  [setIamProfileCrn(iamProfileCrn)](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md) |  | Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server. |
-|  [setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md) |  | Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server. |
+|  [requestToken()](./ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md) | <code>protected</code> |  |
+|  [setIamProfileCrn(iamProfileCrn)](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md) |  | Sets the CRN of the IAM trusted profile to use when fetching the access token from the IAM token server. |
+|  [setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md) |  | Sets the Id of the IAM trusted profile to use when fetching the access token from the IAM token server. |
 

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md

@@ -4,7 +4,7 @@
 
 ## VpcInstanceTokenManager.setIamProfileCrn() method
 
-Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server.
+Sets the CRN of the IAM trusted profile to use when fetching the access token from the IAM token server.
 
 <b>Signature:</b>
 
@@ -16,7 +16,7 @@ setIamProfileCrn(iamProfileCrn: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  iamProfileCrn | string | A string that makes up the iamProfileCrn parameter |
+|  iamProfileCrn | string | the CRN of the IAM trusted profile |
 
 <b>Returns:</b>
 

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md

@@ -4,7 +4,7 @@
 
 ## VpcInstanceTokenManager.setIamProfileId() method
 
-Setter for the "trusted\_profile" parameter to use when fetching the bearer token from the IAM token server.
+Sets the Id of the IAM trusted profile to use when fetching the access token from the IAM token server.
 
 <b>Signature:</b>
 
@@ -16,7 +16,7 @@ setIamProfileId(iamProfileId: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  iamProfileId | string | A string that makes up the iamProfileId parameter |
+|  iamProfileId | string | the ID of the IAM trusted profile |
 
 <b>Returns:</b>