ibm-cloud-sdk-core 5.1.2 → 5.1.4

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

@@ -1,54 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamAssumeAuthenticator](./ibm-cloud-sdk-core.iamassumeauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.iamassumeauthenticator._constructor_.md)
-
-## IamAssumeAuthenticator.(constructor)
-
-Create a new IamAssumeAuthenticator instance.
-
-**Signature:**
-
-```typescript
-constructor(options: Options);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-options
-
-
-</td><td>
-
-Options
-
-
-</td><td>
-
-Configuration options for IAM authentication. This should be an object containing these fields: - apikey: (required) the IAM api key for initial token request - iamProfileId: (optional) the ID of the trusted profile to use - iamProfileCrn: (optional) the CRN of the trusted profile to use - iamProfileName: (optional) the name of the trusted profile to use (must be specified with iamAccountId) - iamAccountId: (optional) the ID of the account the trusted profile is in (must be specified with iamProfileName) - 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
-
-
-</td></tr>
-</tbody></table>
-
-## Exceptions
-
-Error: the configuration options are not valid.
-

package/build/docs/ibm-cloud-sdk-core.iamassumeauthenticator.authenticationtype.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamAssumeAuthenticator](./ibm-cloud-sdk-core.iamassumeauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.iamassumeauthenticator.authenticationtype.md)
-
-## IamAssumeAuthenticator.authenticationType() method
-
-Returns the authenticator's type ('iamAssume').
-
-**Signature:**
-
-```typescript
-authenticationType(): string;
-```
-**Returns:**
-
-string
-
-a string that indicates the authenticator's type
-

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

@@ -1,130 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamAssumeAuthenticator](./ibm-cloud-sdk-core.iamassumeauthenticator.md)
-
-## IamAssumeAuthenticator class
-
-The IamAssumeAuthenticator obtains an IAM access token using the IAM "get-token" operation's "assume" grant type. The authenticator obtains an initial IAM access token from a user-supplied apikey, then exchanges this initial IAM access token for another IAM access token that has "assumed the identity" of the specified trusted profile.
-
-The bearer token will be sent as an Authorization header in the form:
-
-Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
-
-**Signature:**
-
-```typescript
-export declare class IamAssumeAuthenticator extends IamRequestBasedAuthenticatorImmutable 
-```
-**Extends:** IamRequestBasedAuthenticatorImmutable
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(options)](./ibm-cloud-sdk-core.iamassumeauthenticator._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Create a new IamAssumeAuthenticator instance.
-
-
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[tokenManager](./ibm-cloud-sdk-core.iamassumeauthenticator.tokenmanager.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-[IamAssumeTokenManager](./ibm-cloud-sdk-core.iamassumetokenmanager.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[authenticationType()](./ibm-cloud-sdk-core.iamassumeauthenticator.authenticationtype.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Returns the authenticator's type ('iamAssume').
-
-
-</td></tr>
-</tbody></table>

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamAssumeAuthenticator](./ibm-cloud-sdk-core.iamassumeauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.iamassumeauthenticator.tokenmanager.md)
-
-## IamAssumeAuthenticator.tokenManager property
-
-**Signature:**
-
-```typescript
-protected tokenManager: IamAssumeTokenManager;
-```

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

@@ -1,54 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamAssumeTokenManager](./ibm-cloud-sdk-core.iamassumetokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.iamassumetokenmanager._constructor_.md)
-
-## IamAssumeTokenManager.(constructor)
-
-Create a new IamAssumeTokenManager instance.
-
-**Signature:**
-
-```typescript
-constructor(options: Options);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-options
-
-
-</td><td>
-
-Options
-
-
-</td><td>
-
-Configuration options. This should be an object containing these fields: - apikey: (required) the IAM api key - iamProfileId: (optional) the ID of the trusted profile to use - iamProfileCrn: (optional) the CRN of the trusted profile to use - iamProfileName: (optional) the name of the trusted profile to use (must be specified with iamAccountId) - iamAccountId: (optional) the ID of the account the trusted profile is in (must be specified with iamProfileName) - url: (optional) the endpoint URL for the IAM 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
-
-
-</td></tr>
-</tbody></table>
-
-## Exceptions
-
-Error: the configuration options are not valid.
-

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

@@ -1,200 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamAssumeTokenManager](./ibm-cloud-sdk-core.iamassumetokenmanager.md)
-
-## IamAssumeTokenManager class
-
-The IamAssumeTokenManager takes an api key, along with trusted profile information, and performs the necessary interactions with the IAM token service to obtain and store a suitable bearer token that "assumes" the identify of the trusted profile.
-
-**Signature:**
-
-```typescript
-export declare class IamAssumeTokenManager extends IamRequestBasedTokenManager 
-```
-**Extends:** [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md)
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(options)](./ibm-cloud-sdk-core.iamassumetokenmanager._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Create a new IamAssumeTokenManager instance.
-
-
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[requiredOptions](./ibm-cloud-sdk-core.iamassumetokenmanager.requiredoptions.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[requestToken()](./ibm-cloud-sdk-core.iamassumetokenmanager.requesttoken.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-Request an IAM token using a standard access token and a trusted profile.
-
-
-</td></tr>
-<tr><td>
-
-[saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.iamassumetokenmanager.savetokeninfo.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-Extend this method from the parent class to erase the refresh token from the class - we do not want to expose it for IAM Assume authentication.
-
-
-</td></tr>
-<tr><td>
-
-[setClientIdAndSecret(clientId, clientSecret)](./ibm-cloud-sdk-core.iamassumetokenmanager.setclientidandsecret.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Sets the IAM "clientId" and "clientSecret" values for the IAM delegate.
-
-
-</td></tr>
-<tr><td>
-
-[setDisableSslVerification(value)](./ibm-cloud-sdk-core.iamassumetokenmanager.setdisablesslverification.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Sets the "disableSslVerification" property for the IAM delegate.
-
-
-</td></tr>
-<tr><td>
-
-[setHeaders(headers)](./ibm-cloud-sdk-core.iamassumetokenmanager.setheaders.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Sets the headers to be included in the IAM delegate's requests.
-
-
-</td></tr>
-<tr><td>
-
-[setScope(scope)](./ibm-cloud-sdk-core.iamassumetokenmanager.setscope.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Sets the IAM "scope" value. This value is sent as the "scope" form parameter in the IAM delegate request.
-
-
-</td></tr>
-</tbody></table>

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

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamAssumeTokenManager](./ibm-cloud-sdk-core.iamassumetokenmanager.md) &gt; [requestToken](./ibm-cloud-sdk-core.iamassumetokenmanager.requesttoken.md)
-
-## IamAssumeTokenManager.requestToken() method
-
-Request an IAM token using a standard access token and a trusted profile.
-
-**Signature:**
-
-```typescript
-protected requestToken(): Promise<any>;
-```
-**Returns:**
-
-Promise&lt;any&gt;
-

package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.requiredoptions.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamAssumeTokenManager](./ibm-cloud-sdk-core.iamassumetokenmanager.md) &gt; [requiredOptions](./ibm-cloud-sdk-core.iamassumetokenmanager.requiredoptions.md)
-
-## IamAssumeTokenManager.requiredOptions property
-
-**Signature:**
-
-```typescript
-protected requiredOptions: string[];
-```

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

@@ -1,53 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamAssumeTokenManager](./ibm-cloud-sdk-core.iamassumetokenmanager.md) &gt; [saveTokenInfo](./ibm-cloud-sdk-core.iamassumetokenmanager.savetokeninfo.md)
-
-## IamAssumeTokenManager.saveTokenInfo() method
-
-Extend this method from the parent class to erase the refresh token from the class - we do not want to expose it for IAM Assume authentication.
-
-**Signature:**
-
-```typescript
-protected saveTokenInfo(tokenResponse: any): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-tokenResponse
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-the response object from JWT service request
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.setclientidandsecret.md

@@ -1,69 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamAssumeTokenManager](./ibm-cloud-sdk-core.iamassumetokenmanager.md) &gt; [setClientIdAndSecret](./ibm-cloud-sdk-core.iamassumetokenmanager.setclientidandsecret.md)
-
-## IamAssumeTokenManager.setClientIdAndSecret() method
-
-Sets the IAM "clientId" and "clientSecret" values for the IAM delegate.
-
-**Signature:**
-
-```typescript
-setClientIdAndSecret(clientId: string, clientSecret: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-clientId
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-the client id.
-
-
-</td></tr>
-<tr><td>
-
-clientSecret
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-the client secret.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

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

@@ -1,53 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [IamAssumeTokenManager](./ibm-cloud-sdk-core.iamassumetokenmanager.md) &gt; [setDisableSslVerification](./ibm-cloud-sdk-core.iamassumetokenmanager.setdisablesslverification.md)
-
-## IamAssumeTokenManager.setDisableSslVerification() method
-
-Sets the "disableSslVerification" property for the IAM delegate.
-
-**Signature:**
-
-```typescript
-setDisableSslVerification(value: boolean): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-value
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-the new value for the disableSslVerification property
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-