UNPKG

ibm-cloud-sdk-core

Version:

Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.

201 lines (90 loc) 3.09 kB
<!-- 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>