ibm-cloud-sdk-core 5.1.1 → 5.1.3

package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.setheaders.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; [setHeaders](./ibm-cloud-sdk-core.iamassumetokenmanager.setheaders.md)
-
-## IamAssumeTokenManager.setHeaders() method
-
-Sets the headers to be included in the IAM delegate's requests.
-
-**Signature:**
-
-```typescript
-setHeaders(headers: OutgoingHttpHeaders): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-headers
-
-
-</td><td>
-
-OutgoingHttpHeaders
-
-
-</td><td>
-
-the set of headers to send with each request to the token server
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.setscope.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; [setScope](./ibm-cloud-sdk-core.iamassumetokenmanager.setscope.md)
-
-## IamAssumeTokenManager.setScope() method
-
-Sets the IAM "scope" value. This value is sent as the "scope" form parameter in the IAM delegate request.
-
-**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.iamauthenticator._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; [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.iamauthenticator._constructor_.md)
-
-## IamAuthenticator.(constructor)
-
-Create a new IamAuthenticator 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: - 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
-
-
-</td></tr>
-</tbody></table>
-
-## Exceptions
-
-Error: the configuration options are not valid.
-

package/build/docs/ibm-cloud-sdk-core.iamauthenticator.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; [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.iamauthenticator.authenticationtype.md)
-
-## IamAuthenticator.authenticationType() method
-
-Returns the authenticator's type ('iam').
-
-**Signature:**
-
-```typescript
-authenticationType(): string;
-```
-**Returns:**
-
-string
-
-a string that indicates the authenticator's type
-

package/build/docs/ibm-cloud-sdk-core.iamauthenticator.getrefreshtoken.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; [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) &gt; [getRefreshToken](./ibm-cloud-sdk-core.iamauthenticator.getrefreshtoken.md)
-
-## IamAuthenticator.getRefreshToken() method
-
-Return the most recently stored refresh token.
-
-**Signature:**
-
-```typescript
-getRefreshToken(): string;
-```
-**Returns:**
-
-string
-
-the refresh token string
-

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

@@ -1,163 +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; [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md)
-
-## IamAuthenticator class
-
-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 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 &lt;<!-- -->bearer-token<!-- -->&gt;
-
-**Signature:**
-
-```typescript
-export declare class IamAuthenticator extends IamRequestBasedAuthenticator 
-```
-**Extends:** [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.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.iamauthenticator._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Create a new IamAuthenticator 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.iamauthenticator.requiredoptions.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[tokenManager](./ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-[IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.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.iamauthenticator.authenticationtype.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Returns the authenticator's type ('iam').
-
-
-</td></tr>
-<tr><td>
-
-[getRefreshToken()](./ibm-cloud-sdk-core.iamauthenticator.getrefreshtoken.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Return the most recently stored refresh token.
-
-
-</td></tr>
-</tbody></table>

package/build/docs/ibm-cloud-sdk-core.iamauthenticator.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; [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) &gt; [requiredOptions](./ibm-cloud-sdk-core.iamauthenticator.requiredoptions.md)
-
-## IamAuthenticator.requiredOptions property
-
-**Signature:**
-
-```typescript
-protected requiredOptions: string[];
-```

package/build/docs/ibm-cloud-sdk-core.iamauthenticator.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; [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md)
-
-## IamAuthenticator.tokenManager property
-
-**Signature:**
-
-```typescript
-protected tokenManager: IamTokenManager;
-```

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

@@ -1,90 +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 IamRequestBasedAuthenticatorImmutable 
-```
-**Extends:** IamRequestBasedAuthenticatorImmutable
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><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>
-
-[setDisableSslVerification(value)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setdisablesslverification.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not.
-
-
-</td></tr>
-<tr><td>
-
-[setHeaders(headers)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setheaders.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Set headers.
-
-
-</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.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; [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.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; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) &gt; [setDisableSslVerification](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setdisablesslverification.md)
-
-## IamRequestBasedAuthenticator.setDisableSslVerification() method
-
-Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not.
-
-**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>
-
-a flag that indicates whether verification of the token server's SSL certificate should be disabled or not.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setheaders.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; [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) &gt; [setHeaders](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.setheaders.md)
-
-## IamRequestBasedAuthenticator.setHeaders() method
-
-Set headers.
-
-**Signature:**
-
-```typescript
-setHeaders(headers: OutgoingHttpHeaders): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-headers
-
-
-</td><td>
-
-OutgoingHttpHeaders
-
-
-</td><td>
-
-a set of HTTP headers to be sent with each outbound token server request. Overwrites previous default headers.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.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; [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
-