ibm-cloud-sdk-core 5.0.0 → 5.0.2

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

@@ -1,145 +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; [McspAuthenticator](./ibm-cloud-sdk-core.mcspauthenticator.md)
-
-## McspAuthenticator class
-
-The McspAuthenticator uses an apikey to obtain an access token from the MCSP token server. When the access token expires, a new access token is obtained from the token server. The access token will be added to outbound requests via the Authorization header of the form: "Authorization: Bearer <access-token>"
-
-**Signature:**
-
-```typescript
-export declare class McspAuthenticator 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.mcspauthenticator._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Create a new McspAuthenticator 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.mcspauthenticator.requiredoptions.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[tokenManager](./ibm-cloud-sdk-core.mcspauthenticator.tokenmanager.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-[McspTokenManager](./ibm-cloud-sdk-core.mcsptokenmanager.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.mcspauthenticator.authenticationtype.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Returns the authenticator's type ('cp4d').
-
-
-</td></tr>
-</tbody></table>

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

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

package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager._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; [McspTokenManager](./ibm-cloud-sdk-core.mcsptokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.mcsptokenmanager._constructor_.md)
-
-## McspTokenManager.(constructor)
-
-Create a new McspTokenManager 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: - url: (required) the base endpoint URL for the MCSP token service - apikey: (required) the API key used to obtain the MCSP access token. - 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
-
-
-</td></tr>
-</tbody></table>
-
-## Exceptions
-
-Error: the configuration options were invalid.
-

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

@@ -1,128 +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; [McspTokenManager](./ibm-cloud-sdk-core.mcsptokenmanager.md)
-
-## McspTokenManager class
-
-Token Manager for Multi-Cloud Saas Platform (MCSP) authenticator.
-
-The Token Manager will invoke the MCSP token service's 'POST /siusermgr/api/1.0/apikeys/token' operation to obtain an MCSP access token for a user-supplied apikey.
-
-**Signature:**
-
-```typescript
-export declare class McspTokenManager 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.mcsptokenmanager._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Create a new McspTokenManager 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.mcsptokenmanager.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.mcsptokenmanager.requesttoken.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>

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

@@ -1,15 +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; [McspTokenManager](./ibm-cloud-sdk-core.mcsptokenmanager.md) &gt; [requestToken](./ibm-cloud-sdk-core.mcsptokenmanager.requesttoken.md)
-
-## McspTokenManager.requestToken() method
-
-**Signature:**
-
-```typescript
-protected requestToken(): Promise<any>;
-```
-**Returns:**
-
-Promise&lt;any&gt;
-

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