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

ibm-cloud-sdk-core 4.3.3 → 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 (249) hide show

package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofileid.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; [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) &gt; [setIamProfileId](./ibm-cloud-sdk-core.containerauthenticator.setiamprofileid.md)
-## ContainerAuthenticator.setIamProfileId() method
-Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server.
-**Signature:**
-```typescript
-setIamProfileId(iamProfileId: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-iamProfileId
-</td><td>
-string
-</td><td>
-the ID of the IAM trusted profile
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofilename.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; [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) &gt; [setIamProfileName](./ibm-cloud-sdk-core.containerauthenticator.setiamprofilename.md)
-## ContainerAuthenticator.setIamProfileName() method
-Setter for the "profile\_name" parameter to use when fetching the bearer token from the IAM token server.
-**Signature:**
-```typescript
-setIamProfileName(iamProfileName: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-iamProfileName
-</td><td>
-string
-</td><td>
-the name of the IAM trusted profile
-</td></tr>
-</tbody></table>
-**Returns:**
-void

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

package/build/docs/ibm-cloud-sdk-core.containertokenmanager._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; [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.containertokenmanager._constructor_.md)
-## ContainerTokenManager.(constructor)
-Create a new ContainerTokenManager 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: (optional) the endpoint URL for the token service (default: "https://iam.cloud.ibm.com") - crTokenFilename: (optional) the file containing the compute resource token (default: "/var/run/secrets/tokens/vault-token") - iamProfileName: (optional) the name of the IAM trusted profile associated with the compute resource token (required if iamProfileId is not specified) - iamProfileId\]: (optional) the ID of the IAM trusted profile associated with the compute resource token (required if iamProfileName is not specified) - headers: (optional) a set of HTTP headers to be sent with each request to the token service - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - 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
-</td></tr>
-</tbody></table>
-## Exceptions
-Error: the configuration options were invalid

package/build/docs/ibm-cloud-sdk-core.containertokenmanager.getcrtoken.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; [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) &gt; [getCrToken](./ibm-cloud-sdk-core.containertokenmanager.getcrtoken.md)
-## ContainerTokenManager.getCrToken() method
-Retrieves the CR token from a file using this search order: 1. User-specified filename (if specified) 2. Default file \#1 (/var/run/secrets/tokens/vault-token) 3. Default file \#2 (/var/run/secrets/tokens/sa-token) First one found wins.
-**Signature:**
-```typescript
-protected getCrToken(): string;
-```
-**Returns:**
-string
-the CR token value as a string

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

@@ -1,142 +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; [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md)
-## ContainerTokenManager class
-The ContainerTokenManager retrieves a compute resource token from a file on the container. This token is used to perform the necessary interactions with the IAM token service to obtain and store a suitable bearer (access) token.
-**Signature:**
-```typescript
-export declare class ContainerTokenManager 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.containertokenmanager._constructor_.md)
-</td><td>
-</td><td>
-Create a new ContainerTokenManager instance.
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[getCrToken()](./ibm-cloud-sdk-core.containertokenmanager.getcrtoken.md)
-</td><td>
-`protected`
-</td><td>
-Retrieves the CR token from a file using this search order: 1. User-specified filename (if specified) 2. Default file \#1 (/var/run/secrets/tokens/vault-token) 3. Default file \#2 (/var/run/secrets/tokens/sa-token) First one found wins.
-</td></tr>
-<tr><td>
-[requestToken()](./ibm-cloud-sdk-core.containertokenmanager.requesttoken.md)
-</td><td>
-`protected`
-</td><td>
-Request an IAM token using a compute resource token.
-</td></tr>
-<tr><td>
-[setCrTokenFilename(crTokenFilename)](./ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md)
-</td><td>
-</td><td>
-Sets the "crTokenFilename" field
-</td></tr>
-<tr><td>
-[setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md)
-</td><td>
-</td><td>
-Sets the ID of the IAM trusted profile to use when obtaining an access token from the IAM token server.
-</td></tr>
-<tr><td>
-[setIamProfileName(iamProfileName)](./ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md)
-</td><td>
-</td><td>
-Sets the name of the IAM trusted profile to use when obtaining an access token from the IAM token server.
-</td></tr>
-</tbody></table>

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

@@ -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; [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) &gt; [requestToken](./ibm-cloud-sdk-core.containertokenmanager.requesttoken.md)
-## ContainerTokenManager.requestToken() method
-Request an IAM token using a compute resource token.
-**Signature:**
-```typescript
-protected requestToken(): Promise<any>;
-```
-**Returns:**
-Promise&lt;any&gt;

package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.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; [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) &gt; [setCrTokenFilename](./ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md)
-## ContainerTokenManager.setCrTokenFilename() method
-Sets the "crTokenFilename" field
-**Signature:**
-```typescript
-setCrTokenFilename(crTokenFilename: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-crTokenFilename
-</td><td>
-string
-</td><td>
-the name of the file containing the CR token
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.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; [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) &gt; [setIamProfileId](./ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md)
-## ContainerTokenManager.setIamProfileId() method
-Sets the ID of the IAM trusted profile to use when obtaining an access token from the IAM token server.
-**Signature:**
-```typescript
-setIamProfileId(iamProfileId: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-iamProfileId
-</td><td>
-string
-</td><td>
-the ID of the IAM trusted profile
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.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; [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) &gt; [setIamProfileName](./ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md)
-## ContainerTokenManager.setIamProfileName() method
-Sets the name of the IAM trusted profile to use when obtaining an access token from the IAM token server.
-**Signature:**
-```typescript
-setIamProfileName(iamProfileName: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-iamProfileName
-</td><td>
-string
-</td><td>
-the name of the IAM trusted profile
-</td></tr>
-</tbody></table>
-**Returns:**
-void

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

@@ -1,14 +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; [contentType](./ibm-cloud-sdk-core.contenttype.md)
-## contentType variable
-**Signature:**
-```typescript
-_default: {
-    fromFilename: (file: String | File | FileObject | NodeJS.ReadableStream | Buffer) => string;
-    fromHeader: (buffer: Buffer) => string;
-}
-```

package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager._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; [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md)
-## Cp4dTokenManager.(constructor)
-Create a new Cp4dTokenManager 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 endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - 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.