npm - ibm-cloud-sdk-core - Versions diffs - 5.0.0 → 5.0.1 - Mend

ibm-cloud-sdk-core 5.0.0 → 5.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (222) hide show

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.md DELETED Viewed

@@ -1,211 +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; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md)
-## IamRequestBasedAuthenticator class
-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.
-**Signature:**
-```typescript
-export declare class IamRequestBasedAuthenticator extends TokenRequestBasedAuthenticator
-```
-**Extends:** [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.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.iamrequestbasedauthenticator._constructor_.md)
-</td><td>
-</td><td>
-Create a new IamRequestBasedAuthenticator 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>
-[clientId](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientid.md)
-</td><td>
-`protected`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[clientSecret](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientsecret.md)
-</td><td>
-`protected`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[scope](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.scope.md)
-</td><td>
-`protected`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[tokenManager](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.tokenmanager.md)
-</td><td>
-`protected`
-</td><td>
-[IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.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>
-[getRefreshToken()](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.getrefreshtoken.md)
-</td><td>
-</td><td>
-Return the most recently stored refresh token.
-</td></tr>
-<tr><td>
-[setClientIdAndSecret(clientId, clientSecret)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md)
-</td><td>
-</td><td>
-Setter for the mutually inclusive "clientId" and the "clientSecret" fields.
-</td></tr>
-<tr><td>
-[setScope(scope)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md)
-</td><td>
-</td><td>
-Setter for the "scope" parameter to use when fetching the bearer token from the IAM token server.
-</td></tr>
-</tbody></table>

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.scope.md DELETED Viewed

@@ -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; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) &gt; [scope](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.scope.md)
-## IamRequestBasedAuthenticator.scope property
-**Signature:**
-```typescript
-protected scope: string;
-```

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md DELETED Viewed

@@ -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; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) &gt; [setClientIdAndSecret](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md)
-## IamRequestBasedAuthenticator.setClientIdAndSecret() method
-Setter for the mutually inclusive "clientId" and the "clientSecret" fields.
-**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 "clientId" value used to form a Basic Authorization header for IAM token requests
-</td></tr>
-<tr><td>
-clientSecret
-</td><td>
-string
-</td><td>
-the "clientSecret" value used to form a Basic Authorization header for IAM token requests
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md DELETED Viewed

@@ -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; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) &gt; [setScope](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md)
-## IamRequestBasedAuthenticator.setScope() method
-Setter for the "scope" parameter to use when fetching the bearer token from the IAM token server.
-**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>
-(optional) a space-separated string that specifies one or more scopes to be associated with IAM token requests
-</td></tr>
-</tbody></table>
-**Returns:**
-void

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

@@ -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; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.tokenmanager.md)
-## IamRequestBasedAuthenticator.tokenManager property
-**Signature:**
-```typescript
-protected tokenManager: IamRequestBasedTokenManager;
-```

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

@@ -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; [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 DELETED Viewed

@@ -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; [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 DELETED Viewed

@@ -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; [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 DELETED Viewed

@@ -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; [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 DELETED Viewed

@@ -1,221 +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; [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 DELETED Viewed

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