ibm-cloud-sdk-core 5.1.0 → 5.1.1

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

@@ -0,0 +1,200 @@
+<!-- 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)
+
+## IamAssumeTokenManager class
+
+The IamAssumeTokenManager takes an api key, along with trusted profile information, and performs the necessary interactions with the IAM token service to obtain and store a suitable bearer token that "assumes" the identify of the trusted profile.
+
+**Signature:**
+
+```typescript
+export declare class IamAssumeTokenManager 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.iamassumetokenmanager._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new IamAssumeTokenManager 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.iamassumetokenmanager.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.iamassumetokenmanager.requesttoken.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Request an IAM token using a standard access token and a trusted profile.
+
+
+</td></tr>
+<tr><td>
+
+[saveTokenInfo(tokenResponse)](./ibm-cloud-sdk-core.iamassumetokenmanager.savetokeninfo.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+Extend this method from the parent class to erase the refresh token from the class - we do not want to expose it for IAM Assume authentication.
+
+
+</td></tr>
+<tr><td>
+
+[setClientIdAndSecret(clientId, clientSecret)](./ibm-cloud-sdk-core.iamassumetokenmanager.setclientidandsecret.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the IAM "clientId" and "clientSecret" values for the IAM delegate.
+
+
+</td></tr>
+<tr><td>
+
+[setDisableSslVerification(value)](./ibm-cloud-sdk-core.iamassumetokenmanager.setdisablesslverification.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the "disableSslVerification" property for the IAM delegate.
+
+
+</td></tr>
+<tr><td>
+
+[setHeaders(headers)](./ibm-cloud-sdk-core.iamassumetokenmanager.setheaders.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the headers to be included in the IAM delegate's requests.
+
+
+</td></tr>
+<tr><td>
+
+[setScope(scope)](./ibm-cloud-sdk-core.iamassumetokenmanager.setscope.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the IAM "scope" value. This value is sent as the "scope" form parameter in the IAM delegate request.
+
+
+</td></tr>
+</tbody></table>

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

@@ -0,0 +1,17 @@
+<!-- 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; [requestToken](./ibm-cloud-sdk-core.iamassumetokenmanager.requesttoken.md)
+
+## IamAssumeTokenManager.requestToken() method
+
+Request an IAM token using a standard access token and a trusted profile.
+
+**Signature:**
+
+```typescript
+protected requestToken(): Promise<any>;
+```
+**Returns:**
+
+Promise&lt;any&gt;
+

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

package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.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; [IamAssumeTokenManager](./ibm-cloud-sdk-core.iamassumetokenmanager.md) &gt; [saveTokenInfo](./ibm-cloud-sdk-core.iamassumetokenmanager.savetokeninfo.md)
+
+## IamAssumeTokenManager.saveTokenInfo() method
+
+Extend this method from the parent class to erase the refresh token from the class - we do not want to expose it for IAM Assume authentication.
+
+**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.iamassumetokenmanager.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; [IamAssumeTokenManager](./ibm-cloud-sdk-core.iamassumetokenmanager.md) &gt; [setClientIdAndSecret](./ibm-cloud-sdk-core.iamassumetokenmanager.setclientidandsecret.md)
+
+## IamAssumeTokenManager.setClientIdAndSecret() method
+
+Sets the IAM "clientId" and "clientSecret" values for the IAM delegate.
+
+**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.iamassumetokenmanager.setdisablesslverification.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; [IamAssumeTokenManager](./ibm-cloud-sdk-core.iamassumetokenmanager.md) &gt; [setDisableSslVerification](./ibm-cloud-sdk-core.iamassumetokenmanager.setdisablesslverification.md)
+
+## IamAssumeTokenManager.setDisableSslVerification() method
+
+Sets the "disableSslVerification" property for the IAM delegate.
+
+**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>
+
+the new value for the disableSslVerification property
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

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

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

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

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

@@ -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; [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
+