ibm-cloud-sdk-core 4.3.2-beta-2 → 4.3.3

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

@@ -0,0 +1,54 @@
+<!-- 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; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md)
+
+## IamRequestBasedTokenManager.(constructor)
+
+Create a new IamRequestBasedTokenManager instance.
+
+**Signature:**
+
+```typescript
+constructor(options: IamRequestOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md)
+
+
+</td><td>
+
+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
+
+
+</td></tr>
+</tbody></table>
+
+## Exceptions
+
+Error: the configuration options are not valid.
+

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md

@@ -0,0 +1,11 @@
+<!-- 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; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [formData](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md)
+
+## IamRequestBasedTokenManager.formData property
+
+**Signature:**
+
+```typescript
+protected formData: any;
+```

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md

@@ -0,0 +1,19 @@
+<!-- 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; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [getRefreshToken](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md)
+
+## IamRequestBasedTokenManager.getRefreshToken() method
+
+Returns the most recently stored refresh token.
+
+**Signature:**
+
+```typescript
+getRefreshToken(): string;
+```
+**Returns:**
+
+string
+
+the refresh token
+

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.istokenexpired.md

@@ -0,0 +1,19 @@
+<!-- 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; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [isTokenExpired](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.istokenexpired.md)
+
+## IamRequestBasedTokenManager.isTokenExpired() method
+
+Returns true iff the currently-cached IAM access token is expired. We'll consider an access token as expired when we reach its IAM server-reported expiration time minus our expiration window (10 secs). We do this to avoid using an access token that might expire in the middle of a long-running transaction within an IBM Cloud service.
+
+**Signature:**
+
+```typescript
+protected isTokenExpired(): boolean;
+```
+**Returns:**
+
+boolean
+
+true if the token has expired, false otherwise
+

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

@@ -0,0 +1,221 @@
+<!-- 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; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md)
+
+## IamRequestBasedTokenManager class
+
+The IamRequestBasedTokenManager class contains code relevant to any token manager that interacts with the IAM service to manage a token. It stores information relevant to all IAM requests, such as the client ID and secret, and performs the token request with a set of request options common to any IAM token management scheme. It is intended that this class be extended with specific implementations.
+
+**Signature:**
+
+```typescript
+export declare class IamRequestBasedTokenManager extends JwtTokenManager 
+```
+**Extends:** [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.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.iamrequestbasedtokenmanager._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new IamRequestBasedTokenManager 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>
+
+[formData](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[refreshToken](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.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>
+
+[getRefreshToken()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Returns the most recently stored refresh token.
+
+
+</td></tr>
+<tr><td>
+
+[isTokenExpired()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.istokenexpired.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Returns true iff the currently-cached IAM access token is expired. We'll consider an access token as expired when we reach its IAM server-reported expiration time minus our expiration window (10 secs). We do this to avoid using an access token that might expire in the middle of a long-running transaction within an IBM Cloud service.
+
+
+</td></tr>
+<tr><td>
+
+[requestToken()](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Request an IAM access token using an API key.
+
+
+</td></tr>
+<tr><td>
+
+[saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Extend this method from the parent class to extract the refresh token from the request and save it.
+
+
+</td></tr>
+<tr><td>
+
+[setClientIdAndSecret(clientId, clientSecret)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md)
+
+
+</td><td>
+
+
+</td><td>
+
+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).
+
+
+</td></tr>
+<tr><td>
+
+[setScope(scope)](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the IAM "scope" value. This value is sent as the "scope" form parameter within the request sent to the IAM token service.
+
+
+</td></tr>
+</tbody></table>

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.md

@@ -0,0 +1,11 @@
+<!-- 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; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [refreshToken](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.md)
+
+## IamRequestBasedTokenManager.refreshToken property
+
+**Signature:**
+
+```typescript
+protected refreshToken: string;
+```

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

@@ -0,0 +1,19 @@
+<!-- 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; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [requestToken](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md)
+
+## IamRequestBasedTokenManager.requestToken() method
+
+Request an IAM access token using an API key.
+
+**Signature:**
+
+```typescript
+protected requestToken(): Promise<any>;
+```
+**Returns:**
+
+Promise&lt;any&gt;
+
+Promise
+

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

@@ -0,0 +1,53 @@
+<!-- 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; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [saveTokenInfo](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md)
+
+## IamRequestBasedTokenManager.saveTokenInfo() method
+
+Extend this method from the parent class to extract the refresh token from the request and save it.
+
+**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.iamrequestbasedtokenmanager.setclientidandsecret.md

@@ -0,0 +1,69 @@
+<!-- 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; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [setClientIdAndSecret](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md)
+
+## IamRequestBasedTokenManager.setClientIdAndSecret() method
+
+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).
+
+**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.iamrequestbasedtokenmanager.setscope.md

@@ -0,0 +1,53 @@
+<!-- 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; [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md) &gt; [setScope](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md)
+
+## IamRequestBasedTokenManager.setScope() method
+
+Sets the IAM "scope" value. This value is sent as the "scope" form parameter within the request sent to the IAM token service.
+
+**Signature:**
+
+```typescript
+setScope(scope: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+scope
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+a space-separated string that contains one or more scope names
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientid.md

@@ -0,0 +1,11 @@
+<!-- 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; [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) &gt; [clientId](./ibm-cloud-sdk-core.iamrequestoptions.clientid.md)
+
+## IamRequestOptions.clientId property
+
+**Signature:**
+
+```typescript
+clientId?: string;
+```

package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md

@@ -0,0 +1,11 @@
+<!-- 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; [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) &gt; [clientSecret](./ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md)
+
+## IamRequestOptions.clientSecret property
+
+**Signature:**
+
+```typescript
+clientSecret?: string;
+```

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

@@ -0,0 +1,96 @@
+<!-- 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; [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md)
+
+## IamRequestOptions interface
+
+Configuration options for IAM token retrieval.
+
+**Signature:**
+
+```typescript
+export interface IamRequestOptions extends JwtTokenManagerOptions 
+```
+**Extends:** [JwtTokenManagerOptions](./ibm-cloud-sdk-core.jwttokenmanageroptions.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[clientId?](./ibm-cloud-sdk-core.iamrequestoptions.clientid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[clientSecret?](./ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[scope?](./ibm-cloud-sdk-core.iamrequestoptions.scope.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>

package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.scope.md

@@ -0,0 +1,11 @@
+<!-- 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; [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) &gt; [scope](./ibm-cloud-sdk-core.iamrequestoptions.scope.md)
+
+## IamRequestOptions.scope property
+
+**Signature:**
+
+```typescript
+scope?: string;
+```